NotifyShipments()

Notify marketplace of a shipment

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.

Array of objects (ShipmentNotification)

A list of orders that have been shipped

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/shipment_notification
Request samples
application/json
{
  • "transaction_id": "string",
  • "auth": {
    },
  • "notifications": [
    ]
}
Response samples
application/json
{
  • "notification_results": [
    ]
}