SalesOrdersExport

Get sales orders based on filter criteria

Request
Request Body schema:

The criteria of which sales orders to retrieve

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.

object

overwrites of default mapping of sales order statuses. Key: integration's status, Values: 'AwaitingPayment', 'AwaitingShipment', 'Cancelled', 'Completed', 'OnHold', 'PendingFulfillment'

object

allows for mapping of custom 3rd party SalesOrder fields to properties on RequestedFulfillmentExtensions

object
cursor
string

The value returned from a previous request when more pages of data are availalble. The criteria is ignored when this value is present.

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/sales_orders_export
Request samples
{
  • "transaction_id": "string",
  • "auth": {
    },
  • "sales_order_status_mappings": {
    },
  • "sales_order_field_mappings": {
    },
  • "criteria": {
    },
  • "cursor": "string"
}
Response samples
application/json
{
  • "sales_orders": [
    ],
  • "cursor": "string"
}