Order API (2.1.0)

Download OpenAPI specification:Download

ShipEngine Connect: connect@shipengine.com URL: https://connect.shipengine.com/ License: Apache-2.0

This API specification describes the canonical ShipEngine eCommerce API Order Source module. A module which implements this specification can be integrated with the ShipEngine eCommerce Platform as an Order Source.

GetConnectionContext()

Return any addditional connection context not collected by the connection modal or OAuth flow.

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.

Responses
200
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/get_connection_context
Request samples
application/json
{
  • "transaction_id": "string",
  • "auth": {
    }
}
Response samples
application/json
{
  • "connection_context": {
    }
}