Consignment Gateways

Add Gateways to a Consignment

post/consignments/{consignmentId}/gateways

Request

  • Base URL: https://api.reelables.com/v1
  • URL: https://api.reelables.com/v1/consignments/{consignmentId}/gateways
  • Auth: OAuth 2 (client credentials, token URL https://auth.reelables.com/oauth2/token, scopes: https://auth.reelables.com/full-access)

Path parameters

consignmentIdstring required

The identifier of the Consignment

Headers

request-idstring

Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Request body

registerGatewayboolean

Indicates whether the gateway should be registered. True - will register a new gateway (productName is required) False - indicates that the gateway has already been registered

deviceIdstring required

Manufacturer identifier for the Gateway device. Example: 'e10fce301222e588e1d7482b'

productNamestring

Name of Gateway product. Example: 'HGD4'

manufacturer'hpeAruba' | 'cassiaNetworks' | 'particle' | 'sysLoco' | 'versa' required

Gateway manufacturer. Example: 'sysLoco'. If you want us to support a new manufacturer, please contact us at support@reelables.com

Response

201 response

nextTokenstring

Pagination token

Changes

No recorded changes to this operation across all 1 revision of this API.