ExportSalesOrders()

Get sales orders based on filter criteria

Request

Request Body schema: application/json

A request to export a range of sales orders

transaction_id required	string <uuid> A randomly generated transaction ID, used to correlate the request and response
	object (Auth) Represents the auth information sent with every request
	object (SalesOrderExportCriteria)
cursor	string Information needed to get this current batch of orders if necessary, this will be set by the export sales order response if there are additional orders to be retrieved.
	object (SalesOrderCustomFieldMappings)
sales_order_status_mappings	object seller specified mappings for custom statuses coming from the 3rd parties api and the SalesOrderStatus they should map to.

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

Payload

application/json

{"transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
"auth": {"order_source_api_code": "windigo",
"username": "user@user.com",
"password": "NotPassword12"
},
"criteria": {"from_date_time": "2021-03-31T18:21:14.858Z",
"to_date_time": "2021-03-31T18:21:14.858Z"
}
}

Response samples

application/json

{"sales_orders": [{"order_id": "string",
"order_number": "string",
"status": "AwaitingPayment",
"paid_date": "2019-08-24T14:15:22Z",
"fulfilled_date": "2019-08-24T14:15:22Z",
"original_order_source": {"source_id": "string",
"marketplace_code": "string",
"order_id": "string"
},
"requested_fulfillments": [{"requested_fulfillment_id": "string",
"ship_to": {"name": "string",
"company": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"city": "string",
"state_province": "string",
"postal_code": "string",
"country_code": "string",
"residential_indicator": "string",
"is_verified": true,
"pickup_location": {"carrier_id": "string",
"relay_id": "string"
}
},
"items": [{"line_item_id": "string",
"description": "string",
"product": {"product_id": null,
"name": null,
"description": null,
"identifiers": { },
"details": [ ],
"unit_cost": null,
"weight": null,
"dimensions": null,
"urls": { },
"location": null
},
"quantity": 0,
"unit_price": 0,
"taxes": [null
],
"shipping_charges": [null
],
"adjustments": [null
],
"item_url": "string",
"modified_date_time": "2019-08-24T14:15:22Z"
}
],
"extensions": {"custom_field_1": "string",
"custom_field_2": "string",
"custom_field_3": "string"
},
"shipping_preferences": {"digital_fulfillment": true,
"additional_handling": true,
"bill_duties_to_sender": true,
"do_not_prepay_postage": true,
"gift": true,
"has_alcohol": true,
"insurance_requested": true,
"non_machinable": true,
"saturday_delivery": true,
"show_postage": true,
"suppress_email_notify": true,
"suppress_marketplace_notify": true,
"deliver_by_date": "2019-08-24T14:15:22Z",
"hold_until_date": "2019-08-24T14:15:22Z",
"ready_to_ship_date": "2019-08-24T14:15:22Z",
"ship_by_date": "2019-08-24T14:15:22Z",
"preplanned_fulfillment_id": "string",
"shipping_service": "string",
"package_type": "string",
"insured_value": 0,
"is_premium_program": true,
"premium_program_name": "string",
"requested_warehouse": "string",
"documents": [{"type": [ ],
"data": null,
"format": null
}
]
},
"branding": {"packing_slip": {"url": "string"
},
"company_name": "string"
}
}
],
"buyer": {"buyer_id": "string",
"name": "string",
"email": "string",
"phone": "string"
},
"bill_to": {"email": "string",
"name": "string",
"company": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"city": "string",
"state_province": "string",
"postal_code": "string",
"country_code": "string",
"residential_indicator": "string",
"is_verified": true,
"pickup_location": {"carrier_id": "string",
"relay_id": "string"
}
},
"currency": "string",
"tax_identifier": {"value": "string",
"type": "TIN"
},
"payment": {"payment_id": "string",
"payment_status": "AwaitingPayment",
"taxes": [{"amount": 0,
"description": "string"
}
],
"shipping_charges": [{"amount": 0,
"description": "string"
}
],
"adjustments": [{"amount": 0,
"description": "string"
}
],
"amount_paid": 0,
"coupon_code": "string",
"payment_method": "string",
"label_voucher": {"url": "string",
"token": "string"
},
"prepaid_vat": [{"amount": 0,
"description": "string"
}
]
},
"ship_from": {"name": "string",
"company": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"address_line_3": "string",
"city": "string",
"state_province": "string",
"postal_code": "string",
"country_code": "string",
"residential_indicator": "string",
"is_verified": true,
"pickup_location": {"carrier_id": "string",
"relay_id": "string"
}
},
"order_url": "string",
"notes": [{"type": "string",
"text": "string"
}
],
"integration_context": "string",
"created_date_time": "2019-08-24T14:15:22Z",
"modified_date_time": "2019-08-24T14:15:22Z"
}
],
"cursor": "string"
}