Services | Hitchhikers

Services: Cancel (Location)

Cancel one or more active services provisioned on the location.

NOTE: If you have added location services under a sub-account, use this endpoint on your main account to cancel them.

path Parameters

accountId

required

string

The ID of the account.

NOTE: If you would like to cancel location services under a sub-account, enter the ID of the main account rather than the sub-account.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

locationId required	string
locationAccountId	string (Partner Portal mode only) The account that the location receiving service is in.
agreementId	integer The ID of the agreement under which you want services canceled. You do not need to supply this except in advanced scenarios.
skus	Array of strings List of SKUs that you would like to cancel on the location. The location must have active services for at least one of the provided SKUs. If you do not provide a list of SKUs, all active services for the location will be canceled.

Responses

Request samples

Payload

Content type

application/json

{"locationId": "L439843",
"locationAccountId": "C34833",
"agreementId": 1588,
"skus": ["SKU-00000167",
"SKU-00000168"
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": [{"id": 8018,
"sku": "DEV-00010003",
"serviceDescription": "Axciom Add-on (Partner)",
"agreementId": 1588,
"locationId": "1775725677797917505",
"status": "STOPPED",
"started": "2017-02-10",
"stopped": "2017-05-14"
}
]
}

Services: Cancel (Account)

Cancel (or decrease the quantity of) one or more active services provisioned on the account.

NOTE: If you have added services to a sub-account, use this endpoint on your main account to cancel them.

path Parameters

accountId

required

string

The ID of the account.

NOTE: Enter the ID of the main account rather than the sub-account to cancel services provisioned on the sub-account.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

subAccountId required	string
required	Array of objects List of objects representing the SKUs to be removed (or decreased in quantity) from the sub-account. The sub-account must have active services for at least one of the provided SKUs. If the decrease in quantity would result in 0 service quantity, the service will be STOPPED. The removed quantity will default to 1 for any SKU without a specified quantity. To cancel all active services provisioned on the account, use the Services: Cancel All (Account) endpoint.
agreementId	integer The ID of the agreement under which you want services canceled. You do not need to supply this except in advanced scenarios.

Responses

Request samples

Payload

Content type

application/json

{"subAccountId": "B093879",
"skuRemovals": [{"sku": "SKU-00000195",
"quantity": 1
},
{"sku": "SKU-00000196",
"quantity": 2
}
],
"agreementId": 1588
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": [{"id": 9000,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000195",
"serviceDescription": "Answers Experience",
"serviceQuantity": 2,
"started": "2021-01-10",
"status": "ACTIVE"
},
{"id": 9001,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000196",
"serviceDescription": "Answers Experience 2",
"serviceQuantity": 1,
"started": "2021-01-10",
"stopped": "2021-03-01",
"status": "STOPPED"
}
]
}

Services: Cancel All (Account)

Cancel all active services (all quantities) provisioned on the account.

NOTE: If you have added services to a sub-account, use this endpoint on your main account to cancel all of them.

path Parameters

accountId

required

string

The ID of the account.

NOTE: Enter the ID of the main account rather than the sub-account to cancel all of the services provisioned on the sub-account.

query Parameters

v

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

subAccountId required	string
agreementId	integer The ID of the agreement under which you want services canceled. You do not need to supply this except in advanced scenarios.

Responses

Request samples

Payload

Content type

application/json

{"subAccountId": "B093879",
"agreementId": 1588
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": [{"id": 9000,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000195",
"serviceDescription": "Answers Experience",
"serviceQuantity": 1,
"started": "2021-01-10",
"stopped": "2021-03-01",
"status": "STOPPED"
},
{"id": 9001,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000196",
"serviceDescription": "Answers Experience 2",
"serviceQuantity": 3,
"started": "2021-01-10",
"stopped": "2021-03-01",
"status": "STOPPED"
},
{"id": 9002,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000197",
"serviceDescription": "Answers Experience 3",
"serviceQuantity": 1,
"started": "2021-01-11",
"stopped": "2021-03-01",
"status": "STOPPED"
}
]
}

Services: List (Location)

Retrieve a list of all services provisioned on a location.

NOTE: If you have added location services under sub-accounts, they will be returned from this endpoint on your main account.

path Parameters

accountId

required

string

The ID of the account.

NOTE: To retrieve information about services provisioned on a location under a sub-account, enter the ID of the main account rather than the sub-account.

query Parameters

v required	string A date in `YYYYMMDD` format.
sku	string
locationId	string
locationAccountId	string (Portal Mode only) Filters on the account that the location receiving service is in.
status	string Enum: "ACTIVE" "STOPPED" "ALL" Status of the service. By default, returns only Active services, not All services.
agreementId	integer
limit	integer <= 1000 Default: 100
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"count": 3,
"services": [{"id": 8000,
"sku": "SKU-00000170",
"serviceDescription": "Axciom Add-on (Partner)",
"agreementId": 1588,
"locationId": "LOC-123",
"status": "ACTIVE",
"started": "2017-05-13"
},
{"id": 8001,
"sku": "SKU-00000167",
"serviceDescription": "Location Cloud Starter (Partner)",
"agreementId": 1588,
"locationId": "LOC-123",
"status": "ACTIVE",
"started": "2017-05-10"
},
{"id": 8002,
"sku": "SKU-00000167",
"serviceDescription": "Location Cloud Starter (Partner)",
"agreementId": 1588,
"locationId": "LOC-267",
"status": "STOPPED",
"started": "2017-05-10",
"stopped": "2017-05-15"
}
]
}
}

Services: List (Sub-Account)

Retrieve a list of all services provisioned on a sub-account.

NOTE: If you have added services to sub-accounts, they will be returned from this endpoint on your main account.

path Parameters

accountId

required

string

The ID of the account.

NOTE: To retrieve information about services provisioned on a sub-account, enter the ID of the main account rather than the sub-account.

query Parameters

v required	string A date in `YYYYMMDD` format.
sku	string
subAccountId	string
status	string Enum: "ACTIVE" "STOPPED" "ALL" Status of the service. By default, returns only Active services, not All services.
agreementId	integer
limit	integer <= 1000 Default: 100
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"count": 3,
"services": [{"id": 8000,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000195",
"serviceDescription": "Answers Experience",
"serviceQuantity": 3,
"started": "2021-02-03",
"status": "ACTIVE"
},
{"id": 8001,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000196",
"serviceDescription": "Answers Experience 2",
"serviceQuantity": 1,
"started": "2021-02-25",
"status": "ACTIVE"
},
{"id": 8002,
"subAccountId": "B093879",
"agreementId": 1588,
"sku": "SKU-00000197",
"serviceDescription": "Answers Experience 3",
"serviceQuantity": 1,
"started": "2021-02-26",
"status": "ACTIVE"
}
]
}
}