API Reference

[EARLY ACCESS] Import sales order

post
https://{xentralId}.xentral.biz/api/salesOrders/actions/import

Import a sales order from external marketplace

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Sales order import request payload

date
required
string

Customer-facing sales order number in the originating shop system / platform (e.g. Shopify, Amazon, etc)

string

technical sales order ID in the originating shop system / platform (e.g. Shopify, Amazyon, etc). This ID is used to sync status updates & tracking info back to the originating shop / platform

string

transaction number typically used to identify payment transactions in the originating shop system / platforms (e.g. Shopify, Amazon, etc). This ID is typically used for financial reconciliation of payment transactions with sales orders / invoices in Xentral.

string

Purchase Order number from the customer’s purchase order system, typically used in B2B context.

string
string
string
string
tags
array of objects
tags
customer
object
required

Reference to another resource

project
object
required

Reference to another resource

salesChannel
object

Reference to another resource

language
object

Language information for a Sales Order

financials
object
required

Financial information for a Sales Order

delivery
object
required
positions
array of objects
required
positions*
discountPositions
array of objects
discountPositions
Headers
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

403

Unable to authorize the client

406

Requested resource representation does not exist.

Updated almost 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/problem+json

Updated almost 2 years ago