loading

Services API | Hitchhikers Platform

Overview

The Services Administrative API endpoints allows you to retrieve a list of all services provisioned on a sub-account, as well as cancel existing services for sub-accounts.

Use Cases
  • Retrieve a list of all services provisioned on a location.
  • Cancel (or decrease the quantity of) one or more active services provisioned on a sub-account

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

Content type
application/json
{
  • "locationId": "L439843",
  • "locationAccountId": "C34833",
  • "agreementId": 1588,
  • "skus": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": [
    ]
}

Services: Cancel (Sub-Account)

Cancel (or decrease the quantity of) one or more active services provisioned on the sub-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 sub-account, use the Services: Cancel All (Sub-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

Content type
application/json
{
  • "subAccountId": "B093879",
  • "skuRemovals": [
    ],
  • "agreementId": 1588
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": [
    ]
}

Services: Cancel All (Sub-Account)

Cancel all active services (all quantities) provisioned on the sub-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

Content type
application/json
{
  • "subAccountId": "B093879",
  • "agreementId": 1588
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": [
    ]
}

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

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

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

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}