RegisterDeliveryOptions

Initiates registeration of a delivery options entry in the order source

Request
Request Body schema: application/json
transaction_id
required
string <guid>

A randomly generated transaction ID, used to correlate the request and response

required
object

The authorization information necessary to fulfill this request.

callback_url
required
string

Callback url to register with the order source

marketplace_key
required
string

Marketplace key to be returned in delivery options calls from the order source

option_key
required
string

Option metadata to be returned in delivery options calls from the order source

Responses
200

OK

400

A response to indicate that there was either a module level client error or an external client error.

401

A response to indicate that the request failed to authenticate with the shipping provider.

404

A response to indicate that the module does not implement this endpoint.

429

A response indicates that the shipping service provider has denied a request due to too many requests.

500

A response indicating a server level error with the module.

520

A response indicating a server level error with the external world.

post/register_delivery_options
Request samples
application/json
{
  • "transaction_id": "string",
  • "auth": {
    },
  • "callback_url": "string",
  • "marketplace_key": "string",
  • "option_key": "string"
}
Response samples
application/json
{
  • "connection_id": "string",
  • "succeeded": true,
  • "failure_reason": "string"
}