Sales Orders

Sales Orders

post

Body

application/json

customerstringRequired

pick_locationstring · nullableOptionalDefault: null

shipping_locationstring · nullableOptionalDefault: null

delivery_datestring · nullableOptionalDefault: null

shipping_namestring · nullableOptionalDefault: null

shipping_feenumber · nullableOptionalDefault: null

shipping_fee_taxnumber · nullableOptionalDefault: null

invoice_due_atstring · nullableOptionalDefault: null

payment_methodstring · nullableOptionalDefault: null

referencestring · nullableOptionalDefault: null

notesstring · nullableOptionalDefault: null

statusstringOptionalDefault: DRAFT

Responses

201

Created

application/json

post

/v1/sales-orders/

HTTPcURLJavaScriptPython

POST /v1/sales-orders/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 324

{
  "customer": "text",
  "pick_location": "text",
  "shipping_location": "text",
  "delivery_date": "text",
  "shipping_name": "text",
  "shipping_fee": 1,
  "shipping_fee_tax": 1,
  "invoice_due_at": "text",
  "payment_method": "text",
  "reference": "text",
  "notes": "text",
  "status": "DRAFT",
  "line_items": [
    {
      "product_id": 1,
      "qty": 1,
      "carton_qty": 1,
      "carton_price": 1
    }
  ]
}

201

Created

{
  "id": "text",
  "type": "Internal",
  "supplier_id": 1,
  "order_number": "text",
  "source": "text",
  "status": "text",
  "reference": "text",
  "created_at": "text",
  "modified_at": "text",
  "invoice_due_at": "text",
  "shipped_at": "text",
  "paid_at": "text",
  "completed_at": "text",
  "pick_location_id": "text",
  "pick_location_name": "text",
  "delivery_date": "text",
  "currency": "text",
  "amount": 1,
  "amount_notax": 1,
  "amount_tax": 1,
  "amount_paid": 1,
  "payment_method": "text",
  "shipping_name": "text",
  "shipping_fee": 1,
  "shipping_fee_notax": 1,
  "shipping_fee_tax": 1,
  "credit_card_fee": 1,
  "credit_card_fee_notax": 1,
  "credit_card_fee_tax": 1,
  "credit": 1,
  "credit_notax": 1,
  "credit_tax": 1,
  "notes": "text",
  "last_modified_at": "text",
  "line_items": [
    {
      "id": 1,
      "order_id": 1,
      "product_id": 1,
      "sku": "text",
      "barcode": "text",
      "name": "text",
      "qty": 1,
      "carton_qty": 1,
      "carton_price": 1,
      "amount": 1,
      "amount_notax": 1,
      "amount_tax": 1
    }
  ],
  "customer": {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "account_number": "text",
    "website": "text",
    "logo_url": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "credit_hold": true,
    "notes": "text",
    "last_modified_at": "text",
    "contacts": [
      {
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "phone": "text",
        "mobile_area": "text",
        "mobile_number": "text",
        "role": "text"
      }
    ],
    "locations": [
      {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "billing_location": {
      "id": "text",
      "name": "text",
      "is_billing": true,
      "is_shipping": true,
      "manage_stock": true,
      "address": "text",
      "suburb": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "location": {},
      "opening_hours": {}
    },
    "shipping_location": {
      "id": "text",
      "name": "text",
      "is_billing": true,
      "is_shipping": true,
      "manage_stock": true,
      "address": "text",
      "suburb": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "location": {},
      "opening_hours": {}
    }
  }
}

get

Query parameters

idstringRequired

Responses

200

OK

application/json

idstringOptional

typestring · enumOptionalPossible values:

supplier_idintegerOptional

order_numberstring · nullableOptional

sourcestring · nullableOptional

statusstring · nullableOptional

referencestring · nullableOptional

created_atstring · datetimeOptional

modified_atstring · datetimeOptional

invoice_due_atstring · datetime · nullableOptional

shipped_atstring · datetime · nullableOptional

paid_atstring · datetime · nullableOptional

completed_atstring · datetime · nullableOptional

pick_location_idstring · nullableOptional

pick_location_namestring · nullableOptional

delivery_datestring · datetime · nullableOptional

currencystringOptional

amountnumberOptional

amount_notaxnumberOptional

amount_taxnumberOptional

amount_paidnumber · nullableOptional

payment_methodstring · nullableOptional

shipping_namestring · nullableOptional

shipping_feenumber · nullableOptional

shipping_fee_notaxnumber · nullableOptional

shipping_fee_taxnumber · nullableOptional

credit_card_feenumber · nullableOptional

credit_card_fee_notaxnumber · nullableOptional

credit_card_fee_taxnumber · nullableOptional

creditnumber · nullableOptional

credit_notaxnumber · nullableOptional

credit_taxnumber · nullableOptional

notesstringOptional

last_modified_atstring · nullableOptional

get

/v1/sales-orders/get

HTTPcURLJavaScriptPython

GET /v1/sales-orders/get?id=text HTTP/1.1
Accept: */*

200

OK

{
  "id": "text",
  "type": "Internal",
  "supplier_id": 1,
  "order_number": "text",
  "source": "text",
  "status": "text",
  "reference": "text",
  "created_at": "text",
  "modified_at": "text",
  "invoice_due_at": "text",
  "shipped_at": "text",
  "paid_at": "text",
  "completed_at": "text",
  "pick_location_id": "text",
  "pick_location_name": "text",
  "delivery_date": "text",
  "currency": "text",
  "amount": 1,
  "amount_notax": 1,
  "amount_tax": 1,
  "amount_paid": 1,
  "payment_method": "text",
  "shipping_name": "text",
  "shipping_fee": 1,
  "shipping_fee_notax": 1,
  "shipping_fee_tax": 1,
  "credit_card_fee": 1,
  "credit_card_fee_notax": 1,
  "credit_card_fee_tax": 1,
  "credit": 1,
  "credit_notax": 1,
  "credit_tax": 1,
  "notes": "text",
  "last_modified_at": "text",
  "line_items": [
    {
      "id": 1,
      "order_id": 1,
      "product_id": 1,
      "sku": "text",
      "barcode": "text",
      "name": "text",
      "qty": 1,
      "carton_qty": 1,
      "carton_price": 1,
      "amount": 1,
      "amount_notax": 1,
      "amount_tax": 1
    }
  ],
  "customer": {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "account_number": "text",
    "website": "text",
    "logo_url": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "credit_hold": true,
    "notes": "text",
    "last_modified_at": "text",
    "contacts": [
      {
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "phone": "text",
        "mobile_area": "text",
        "mobile_number": "text",
        "role": "text"
      }
    ],
    "locations": [
      {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "billing_location": {
      "id": "text",
      "name": "text",
      "is_billing": true,
      "is_shipping": true,
      "manage_stock": true,
      "address": "text",
      "suburb": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "location": {},
      "opening_hours": {}
    },
    "shipping_location": {
      "id": "text",
      "name": "text",
      "is_billing": true,
      "is_shipping": true,
      "manage_stock": true,
      "address": "text",
      "suburb": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "location": {},
      "opening_hours": {}
    }
  }
}

get

Query parameters

pageintegerOptional

Responses

200

OK

application/json

get

/v1/sales-orders/latest

HTTPcURLJavaScriptPython

GET /v1/sales-orders/latest HTTP/1.1
Accept: */*

200

OK

[
  {
    "id": "text",
    "type": "Internal",
    "supplier_id": 1,
    "order_number": "text",
    "source": "text",
    "status": "text",
    "reference": "text",
    "created_at": "text",
    "modified_at": "text",
    "invoice_due_at": "text",
    "shipped_at": "text",
    "paid_at": "text",
    "completed_at": "text",
    "pick_location_id": "text",
    "pick_location_name": "text",
    "delivery_date": "text",
    "currency": "text",
    "amount": 1,
    "amount_notax": 1,
    "amount_tax": 1,
    "amount_paid": 1,
    "payment_method": "text",
    "shipping_name": "text",
    "shipping_fee": 1,
    "shipping_fee_notax": 1,
    "shipping_fee_tax": 1,
    "credit_card_fee": 1,
    "credit_card_fee_notax": 1,
    "credit_card_fee_tax": 1,
    "credit": 1,
    "credit_notax": 1,
    "credit_tax": 1,
    "notes": "text",
    "last_modified_at": "text",
    "line_items": [
      {
        "id": 1,
        "order_id": 1,
        "product_id": 1,
        "sku": "text",
        "barcode": "text",
        "name": "text",
        "qty": 1,
        "carton_qty": 1,
        "carton_price": 1,
        "amount": 1,
        "amount_notax": 1,
        "amount_tax": 1
      }
    ],
    "customer": {
      "id": "text",
      "type": "Internal",
      "name": "text",
      "abn": "text",
      "account_number": "text",
      "website": "text",
      "logo_url": "text",
      "payment_terms": 1,
      "payment_terms_period": "text",
      "credit_hold": true,
      "notes": "text",
      "last_modified_at": "text",
      "contacts": [
        {
          "first_name": "text",
          "last_name": "text",
          "email": "text",
          "phone": "text",
          "mobile_area": "text",
          "mobile_number": "text",
          "role": "text"
        }
      ],
      "locations": [
        {
          "id": "text",
          "name": "text",
          "is_billing": true,
          "is_shipping": true,
          "manage_stock": true,
          "address": "text",
          "suburb": "text",
          "state": "text",
          "postcode": "text",
          "country": "text",
          "location": {},
          "opening_hours": {}
        }
      ],
      "groups": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "billing_location": {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      },
      "shipping_location": {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    }
  }
]

put

Query parameters

idstringRequired

Body

application/json

shipping_locationstring · nullableOptionalDefault: null

delivery_datestring · nullableOptionalDefault: null

shipping_namestring · nullableOptionalDefault: null

shipping_feenumber · nullableOptionalDefault: null

shipping_fee_taxnumber · nullableOptionalDefault: null

invoice_due_atstring · nullableOptionalDefault: null

payment_methodstring · nullableOptionalDefault: null

notesstring · nullableOptionalDefault: null

statusstatus · nullableOptionalDefault: null

Responses

202

Accepted

application/json

put

/v1/sales-orders/modify

HTTPcURLJavaScriptPython

PUT /v1/sales-orders/modify?id=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 253

{
  "shipping_location": "text",
  "delivery_date": "text",
  "shipping_name": "text",
  "shipping_fee": 1,
  "shipping_fee_tax": 1,
  "invoice_due_at": "text",
  "payment_method": "text",
  "notes": "text",
  "status": null,
  "line_items": [
    {
      "id": 1,
      "qty": 1,
      "carton_qty": 1,
      "carton_price": 1
    }
  ]
}

202

Accepted

{
  "id": "text",
  "type": "Internal",
  "supplier_id": 1,
  "order_number": "text",
  "source": "text",
  "status": "text",
  "reference": "text",
  "created_at": "text",
  "modified_at": "text",
  "invoice_due_at": "text",
  "shipped_at": "text",
  "paid_at": "text",
  "completed_at": "text",
  "pick_location_id": "text",
  "pick_location_name": "text",
  "delivery_date": "text",
  "currency": "text",
  "amount": 1,
  "amount_notax": 1,
  "amount_tax": 1,
  "amount_paid": 1,
  "payment_method": "text",
  "shipping_name": "text",
  "shipping_fee": 1,
  "shipping_fee_notax": 1,
  "shipping_fee_tax": 1,
  "credit_card_fee": 1,
  "credit_card_fee_notax": 1,
  "credit_card_fee_tax": 1,
  "credit": 1,
  "credit_notax": 1,
  "credit_tax": 1,
  "notes": "text",
  "last_modified_at": "text",
  "line_items": [
    {
      "id": 1,
      "order_id": 1,
      "product_id": 1,
      "sku": "text",
      "barcode": "text",
      "name": "text",
      "qty": 1,
      "carton_qty": 1,
      "carton_price": 1,
      "amount": 1,
      "amount_notax": 1,
      "amount_tax": 1
    }
  ],
  "customer": {
    "id": "text",
    "type": "Internal",
    "name": "text",
    "abn": "text",
    "account_number": "text",
    "website": "text",
    "logo_url": "text",
    "payment_terms": 1,
    "payment_terms_period": "text",
    "credit_hold": true,
    "notes": "text",
    "last_modified_at": "text",
    "contacts": [
      {
        "first_name": "text",
        "last_name": "text",
        "email": "text",
        "phone": "text",
        "mobile_area": "text",
        "mobile_number": "text",
        "role": "text"
      }
    ],
    "locations": [
      {
        "id": "text",
        "name": "text",
        "is_billing": true,
        "is_shipping": true,
        "manage_stock": true,
        "address": "text",
        "suburb": "text",
        "state": "text",
        "postcode": "text",
        "country": "text",
        "location": {},
        "opening_hours": {}
      }
    ],
    "groups": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "billing_location": {
      "id": "text",
      "name": "text",
      "is_billing": true,
      "is_shipping": true,
      "manage_stock": true,
      "address": "text",
      "suburb": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "location": {},
      "opening_hours": {}
    },
    "shipping_location": {
      "id": "text",
      "name": "text",
      "is_billing": true,
      "is_shipping": true,
      "manage_stock": true,
      "address": "text",
      "suburb": "text",
      "state": "text",
      "postcode": "text",
      "country": "text",
      "location": {},
      "opening_hours": {}
    }
  }
}

delete

Query parameters

idstringRequired

Responses

202

Accepted

delete

/v1/sales-orders/modify

HTTPcURLJavaScriptPython

DELETE /v1/sales-orders/modify?id=text HTTP/1.1
Accept: */*

202

Accepted

No content