Sales Orders

Download schema

Create a sales order

POST

https://api.skutopia.com

/v0/organizations/{organizationId}/stores/{storeId}/sales-orders

Accepts a sales order for ingestion into SKUTOPIA.

Create a sales order › path Parameters

organizationId

string · required

The organization the store belongs to.

storeId

string · required

The store to create the sales order against.

Create a sales order › Headers

Idempotency-Key

string

Client-supplied key used for idempotency, requests using the same key will return the same result for at least 3 months.

Create a sales order › Request Body

orderReference

string · minLength: 1 · required

Your reference for the order. Displayed for informational purposes.

placedAt

string · required

ISO 8601 timestamp at which the order was placed.

object · required

object[] · minItems: 1 · required

object · required

note

string

A generic order note, can be attached to the order and viewed in the SKUTOPIA Shipping Platform

Create a sales order › Responses

Successful response

salesOrderId

string · required

The SKUTOPIA identifier assigned to the order.

POST/v0/organizations/{organizationId}/stores/{storeId}/sales-orders

curl https://api.skutopia.com/v0/organizations/:organizationId/stores/:storeId/sales-orders \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "orderReference": "orderReference",
  "placedAt": "placedAt",
  "note": "note",
  "customer": {
    "firstName": "firstName",
    "lastName": "lastName",
    "contactNumber": "contactNumber",
    "email": "email"
  },
  "lineItems": [
    {
      "name": "name",
      "sku": "sku",
      "barcode": "barcode",
      "quantity": 1,
      "price": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      },
      "minShelfLifeDays": 0,
      "weightGram": 0,
      "harmonizedCode": "harmonizedCode",
      "countryCodeOfOrigin": "AF"
    }
  ],
  "shipping": {
    "method": "method",
    "authorityToLeave": "NOT_SPECIFIED",
    "labelNote": "labelNote",
    "address": {
      "line1": "line1",
      "line2": "line2",
      "locality": "locality",
      "stateProvince": "stateProvince",
      "postalCode": "postalCode",
      "countryCode": "AF"
    },
    "recipient": {
      "name": "name",
      "company": "company",
      "contactNumber": "contactNumber",
      "email": "email"
    },
    "charged": {
      "amountExcludingTax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      },
      "tax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      }
    },
    "discount": {
      "amountExcludingTax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      },
      "tax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      }
    }
  }
}'

Example Request Body

{
  "orderReference": "orderReference",
  "placedAt": "placedAt",
  "note": "note",
  "customer": {
    "firstName": "firstName",
    "lastName": "lastName",
    "contactNumber": "contactNumber",
    "email": "email"
  },
  "lineItems": [
    {
      "name": "name",
      "sku": "sku",
      "barcode": "barcode",
      "quantity": 1,
      "price": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      },
      "minShelfLifeDays": 0,
      "weightGram": 0,
      "harmonizedCode": "harmonizedCode",
      "countryCodeOfOrigin": "AF"
    }
  ],
  "shipping": {
    "method": "method",
    "authorityToLeave": "NOT_SPECIFIED",
    "labelNote": "labelNote",
    "address": {
      "line1": "line1",
      "line2": "line2",
      "locality": "locality",
      "stateProvince": "stateProvince",
      "postalCode": "postalCode",
      "countryCode": "AF"
    },
    "recipient": {
      "name": "name",
      "company": "company",
      "contactNumber": "contactNumber",
      "email": "email"
    },
    "charged": {
      "amountExcludingTax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      },
      "tax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      }
    },
    "discount": {
      "amountExcludingTax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      },
      "tax": {
        "currency": "AUD",
        "amountInMinorUnit": 1550
      }
    }
  }
}

json

Example Responses

{
  "salesOrderId": "salesOrderId"
}

json

application/json

Get a sales order

GET

https://api.skutopia.com

/v0/organizations/{organizationId}/stores/{storeId}/sales-orders/{salesOrderId}

Fetch a single sales order by its SKUTOPIA identifier.

Get a sales order › path Parameters

organizationId

string · required

The organization the store belongs to.

storeId

string · required

The store the sales order belongs to.

salesOrderId

string · required

The SKUTOPIA identifier of the sales order.

Get a sales order › Responses

Successful response

id

string · required

The SKUTOPIA identifier assigned to the order.

organizationId

string · required

The organization the store belongs to.

storeId

string · required

The store the sales order belongs to.

orderReference

string · required

Your reference for the order.

Example: PUB-100234

status

string · const · required

The current status of the sales order.

Const value: OPEN

placedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

ISO 8601 timestamp at which the order was placed.

lastUpdatedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

ISO 8601 timestamp at which the order was last updated.

object[] · required

The line items on the order.

object · required

Shipping details for the order.

GET/v0/organizations/{organizationId}/stores/{storeId}/sales-orders/{salesOrderId}

curl https://api.skutopia.com/v0/organizations/:organizationId/stores/:storeId/sales-orders/:salesOrderId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "organizationId": "organizationId",
  "storeId": "storeId",
  "orderReference": "PUB-100234",
  "status": "OPEN",
  "placedAt": "2024-08-25T15:00:00Z",
  "lastUpdatedAt": "2024-08-25T15:00:00Z",
  "lineItems": [
    {
      "name": "name",
      "sku": "sku",
      "barcode": "barcode",
      "quantity": 0
    }
  ],
  "shipping": {
    "address": {
      "line1": "line1",
      "line2": "line2",
      "locality": "locality",
      "stateProvince": "stateProvince",
      "postalCode": "postalCode",
      "countryCode": "AU"
    },
    "recipient": {
      "name": "name",
      "company": "company",
      "contactNumber": "contactNumber",
      "email": "email"
    }
  }
}

json

application/json

Organizations

Create a sales order

POST

https://api.skutopia.com

/v0/organizations/{organizationId}/stores/{storeId}/sales-orders

Accepts a sales order for ingestion into SKUTOPIA.

Create a sales order › path Parameters

organizationId

string · required

The organization the store belongs to.

storeId

string · required

The store to create the sales order against.

Create a sales order › Headers

Idempotency-Key

string

Client-supplied key used for idempotency, requests using the same key will return the same result for at least 3 months.

Create a sales order › Request Body

orderReference

string · minLength: 1 · required

Your reference for the order. Displayed for informational purposes.

placedAt

string · required

ISO 8601 timestamp at which the order was placed.

object · required

object[] · minItems: 1 · required

object · required

note

string

A generic order note, can be attached to the order and viewed in the SKUTOPIA Shipping Platform

Create a sales order › Responses

Successful response

salesOrderId

string · required

The SKUTOPIA identifier assigned to the order.

Get a sales order

GET

https://api.skutopia.com

/v0/organizations/{organizationId}/stores/{storeId}/sales-orders/{salesOrderId}

Fetch a single sales order by its SKUTOPIA identifier.

Get a sales order › path Parameters

organizationId

string · required

The organization the store belongs to.

storeId

string · required

The store the sales order belongs to.

salesOrderId

string · required

The SKUTOPIA identifier of the sales order.

Get a sales order › Responses

Successful response

id

string · required

The SKUTOPIA identifier assigned to the order.

organizationId

string · required

The organization the store belongs to.

storeId

string · required

The store the sales order belongs to.

orderReference

string · required

Your reference for the order.

Example: PUB-100234

status

string · const · required

The current status of the sales order.

Const value: OPEN

placedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

ISO 8601 timestamp at which the order was placed.

lastUpdatedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

ISO 8601 timestamp at which the order was last updated.

object[] · required

The line items on the order.

object · required

Shipping details for the order.