Skip to content
Sections

API reference

Ordering

Place orders with suppliers that take them through their API, using the tenant’s own login there, and read the supplier’s order history, invoices and live stock.

The account's connection to a supplier's API

get/v1/account/suppliers/{supplier_id}/connection

Status and hints only; credentials are never returned.

Called by
Account client
Scope
orders:read

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Responses

200The connection.Show
  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • credentialsmap of stringrequired

    Hints only: logins as entered, secrets as their last four characters.

  • featuresarray of stringrequired

    One of place_orders, order_history, invoices, live_stock

  • last_checked_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • last_errorstring | nullrequired
  • order_modestringrequired

    test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

    One of off, test, live

  • statusstringrequired

    verified: the supplier accepted the login at the last check or call. failed: it refused it. unverified: not checked yet, or the supplier was unreachable.

    One of unverified, verified, failed

  • supplier_idstringrequired
  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/connection' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "created_at": "2026-11-09T08:00:00Z",
  "credentials": {
    "password": "…x9Qa",
    "username": "buyer@example.com"
  },
  "features": [
    "place_orders"
  ],
  "last_checked_at": "2026-11-09T08:00:00Z",
  "last_error": "string",
  "order_mode": "off",
  "status": "unverified",
  "supplier_id": "string",
  "updated_at": "2026-11-09T08:00:00Z"
}
Try it in the sandbox

Connect the business's own login at a supplier

put/v1/account/suppliers/{supplier_id}/connection

Only suppliers with an API in Presslane Suppliers (see api_features on the supplier) can be connected; others answer 409 supplier_feature_unavailable. The supplier must be in the account’s list (PUT /v1/account/suppliers). The login is checked with a harmless read first: one the supplier refuses is not saved (409 supplier_auth_failed); if the supplier cannot be reached it is saved as unverified. Stored encrypted; replaces any earlier login.

Called by
Account client
Scope
orders:write

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Headers

  • Idempotency-Keystring

    A repeat within 24 hours returns the first response.

    at most 255 characters

Request body · application/json

  • credentialsmap of stringrequired

    The business's own API login at the supplier, with the fields the supplier's api_credential_fields lists. Uneek Clothing and Ralawise: username and password. PenCarrie: customer_code. Absolute Apparel: api_key.

Responses

200The connection after the change.Show
  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • credentialsmap of stringrequired

    Hints only: logins as entered, secrets as their last four characters.

  • featuresarray of stringrequired

    One of place_orders, order_history, invoices, live_stock

  • last_checked_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • last_errorstring | nullrequired
  • order_modestringrequired

    test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

    One of off, test, live

  • statusstringrequired

    verified: the supplier accepted the login at the last check or call. failed: it refused it. unverified: not checked yet, or the supplier was unreachable.

    One of unverified, verified, failed

  • supplier_idstringrequired
  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X PUT 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/connection' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"credentials":{"password":"secret","username":"buyer@example.com"}}'
Response · 200
{
  "created_at": "2026-11-09T08:00:00Z",
  "credentials": {
    "password": "…x9Qa",
    "username": "buyer@example.com"
  },
  "features": [
    "place_orders"
  ],
  "last_checked_at": "2026-11-09T08:00:00Z",
  "last_error": "string",
  "order_mode": "off",
  "status": "unverified",
  "supplier_id": "string",
  "updated_at": "2026-11-09T08:00:00Z"
}
Try it in the sandbox

Remove the stored login

DEL/v1/account/suppliers/{supplier_id}/connection
Called by
Account client
Scope
orders:write

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Responses

204Removed.
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X DELETE 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/connection' \
  -H "Authorization: Bearer $TOKEN"
Try it in the sandbox

Check the stored login again

post/v1/account/suppliers/{supplier_id}/connection/check
Called by
Account client
Scope
orders:write

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Responses

200The connection with the new status.Show
  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • credentialsmap of stringrequired

    Hints only: logins as entered, secrets as their last four characters.

  • featuresarray of stringrequired

    One of place_orders, order_history, invoices, live_stock

  • last_checked_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • last_errorstring | nullrequired
  • order_modestringrequired

    test: orders are checked and recorded with the request that would be sent, and nothing is sent. live: orders are sent. off: refused.

    One of off, test, live

  • statusstringrequired

    verified: the supplier accepted the login at the last check or call. failed: it refused it. unverified: not checked yet, or the supplier was unreachable.

    One of unverified, verified, failed

  • supplier_idstringrequired
  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X POST 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/connection/check' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "created_at": "2026-11-09T08:00:00Z",
  "credentials": {
    "password": "…x9Qa",
    "username": "buyer@example.com"
  },
  "features": [
    "place_orders"
  ],
  "last_checked_at": "2026-11-09T08:00:00Z",
  "last_error": "string",
  "order_mode": "off",
  "status": "unverified",
  "supplier_id": "string",
  "updated_at": "2026-11-09T08:00:00Z"
}
Try it in the sandbox

The account's invoices from the supplier

get/v1/account/suppliers/{supplier_id}/invoices

Straight from the supplier's API with the account's login. Newest first. Without filters, the last 90 days (or from since).

Called by
Account client
Scope
orders:read

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Query parameters

  • invoice_numberstring
  • order_numberstring

    The supplier's order number.

  • referencestring

    Your reference (purchase order number).

  • datestring (date)

    Invoices on this day.

  • sincestring (date)

    Invoices from this day on, when no other filter is given (default 90 days ago).

  • limitinteger

    Default 100, newest first.

    ≥ 1 · ≤ 500

Responses

200Invoices.Show
  • dataarray of SupplierInvoicerequired
    Child attributes
    • due_onstring (date) | nullrequired

      e.g. 2026-11-21

    • invoice_numberstring | nullrequired
    • invoiced_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • linesarray of objectrequired
      Child attributes
      • amountnumber | nullrequired
      • descriptionstring | nullrequired
      • quantitynumber | nullrequired
      • skustring | nullrequired
      • unit_pricenumber | nullrequired
    • netSupplierMoney | nullrequired
      Child attributes
      • amountnumberrequired
      • currencystring | nullrequired
    • order_numberstring | nullrequired
    • outstandingSupplierMoney | nullrequired
      Child attributes
      • amountnumberrequired
      • currencystring | nullrequired
    • referencestring | nullrequired
    • supplier_datamap of anyrequired

      The supplier's record as it came, for fields not mapped above.

    • taxSupplierMoney | nullrequired
      Child attributes
      • amountnumberrequired
      • currencystring | nullrequired
    • totalSupplierMoney | nullrequired
      Child attributes
      • amountnumberrequired
      • currencystring | nullrequired
  • fetched_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • has_morebooleanrequired

    More matched than limit; narrow the filters.

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/invoices' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "due_on": "2026-11-21",
      "invoice_number": "string",
      "invoiced_at": "2026-11-09T08:00:00Z",
      "lines": [
        {
          "amount": 1,
          "description": "string",
          "quantity": 1,
          "sku": "string",
          "unit_price": 1
        }
      ],
      "net": {
        "amount": 1,
        "currency": "string"
      },
      "order_number": "string",
      "outstanding": {
        "amount": 1,
        "currency": "string"
      },
      "reference": "string",
      "supplier_data": {},
      "tax": {
        "amount": 1,
        "currency": "string"
      },
      "total": {
        "amount": 1,
        "currency": "string"
      }
    }
  ],
  "fetched_at": "2026-11-09T08:00:00Z",
  "has_more": false
}
Try it in the sandbox

The account's orders at the supplier

get/v1/account/suppliers/{supplier_id}/orders

Straight from the supplier's API with the account's login: every order on the account, however it was placed. Newest first. Not stored here; at most 30 supplier calls a minute per account and supplier.

Called by
Account client
Scope
orders:read

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Query parameters

  • referencestring

    Your reference (purchase order number).

  • order_numberstring
  • invoice_numberstring
  • shipment_numberstring
  • tracking_numberstring
  • datestring (date)

    Orders on this day.

  • limitinteger

    Default 100, newest first.

    ≥ 1 · ≤ 500

Responses

200Orders.Show
  • dataarray of SupplierOrderrequired
    Child attributes
    • invoice_numbersarray of stringrequired
    • linesarray of objectrequired
      Child attributes
      • descriptionstring | nullrequired
      • quantitynumber | nullrequired
      • quantity_shippednumber | nullrequired
      • skustring | nullrequired
      • unit_pricenumber | nullrequired
    • order_numberstring | nullrequired
    • ordered_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • referencestring | nullrequired
    • shipment_numbersarray of stringrequired
    • statusstring | nullrequired

      The supplier's own status words.

    • supplier_datamap of anyrequired

      The supplier's record as it came, for fields not mapped above.

    • totalSupplierMoney | nullrequired
      Child attributes
      • amountnumberrequired
      • currencystring | nullrequired
    • tracking_numbersarray of stringrequired
  • fetched_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • has_morebooleanrequired

    More matched than limit; narrow the filters.

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/orders' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "invoice_numbers": [
        "string"
      ],
      "lines": [
        {
          "description": "string",
          "quantity": 1,
          "quantity_shipped": 1,
          "sku": "string",
          "unit_price": 1
        }
      ],
      "order_number": "string",
      "ordered_at": "2026-11-09T08:00:00Z",
      "reference": "string",
      "shipment_numbers": [
        "string"
      ],
      "status": "string",
      "supplier_data": {},
      "total": {
        "amount": 1,
        "currency": "string"
      },
      "tracking_numbers": [
        "string"
      ]
    }
  ],
  "fetched_at": "2026-11-09T08:00:00Z",
  "has_more": false
}
Try it in the sandbox

Stock straight from the supplier

get/v1/account/suppliers/{supplier_id}/stock

Asks the supplier's API now, with the account's login, by SKU, variant or style. A variant is looked up by its style and matched like the stock feed (by SKU, else style, colour and size), so each row's sku is the supplier's own code even where it differs from the catalogue's: send it as supplier_sku to order. For everyday availability use /v1/availability, which is precomputed from the supplier feeds and needs no login; this is for a last check before ordering. Ralawise allows 10 calls a minute per login (each style is one call): ask about at most 7 styles at once, or expect 429 rate_limited with Retry-After. Absolute Apparel: available is the stock available today; what it can get in beyond that is in incoming, without a date. Laltex: a made-to-order item has available: null (FreeStock -1 in supplier_data).

Called by
Account client
Scope
stock:read

Path parameters

  • supplier_idstringrequired

    Supplier ID or slug.

Query parameters

  • skustringrepeatable

    The supplier's SKUs (repeat the parameter).

  • variantstringrepeatable

    Variant IDs of this supplier (repeat the parameter), from at most 10 styles. The answer keeps their rows, with the supplier’s own code as sku.

  • product_codestring

    A style code (GR11): every row of the style. Otherwise up to 50 SKUs and variants together.

Responses

200Stock rows; SKUs the supplier does not know are left out.Show
  • dataarray of SupplierStockrequired
    Child attributes
    • availablenumber | nullrequired
    • colourstring | nullrequired
    • descriptionstring | nullrequired
    • incomingarray of objectrequired
      Child attributes
      • expected_onstring (date) | nullrequired

        e.g. 2026-11-21

      • quantitynumberrequired
    • product_codestring | nullrequired
    • sizestring | nullrequired
    • skustring | nullrequired
    • supplier_datamap of anyrequired

      The supplier's record as it came, for fields not mapped above.

    • supplier_variant_idstring | nullrequired

      Our variant with this SKU, if the catalogue has it.

  • fetched_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/account/suppliers/{supplier_id}/stock' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "available": 1,
      "colour": "string",
      "description": "string",
      "incoming": [
        {
          "expected_on": "2026-11-21",
          "quantity": 1
        }
      ],
      "product_code": "string",
      "size": "string",
      "sku": "string",
      "supplier_data": {},
      "supplier_variant_id": "string"
    }
  ],
  "fetched_at": "2026-11-09T08:00:00Z"
}
Try it in the sandbox

Orders placed through Presslane Suppliers

get/v1/orders

Newest first.

Called by
Account client
Scope
orders:read

Query parameters

  • limitinteger

    Page size, 1–200 (default 50).

    ≥ 1 · ≤ 200

  • starting_afterstring

    The next_cursor from the previous page.

    at most 80 characters

  • supplier_idstring
  • statusstring

    One of test, pending, submitted, unconfirmed, failed

  • referencestring

Responses

200A page of orders.Show
  • dataarray of Orderrequired
    Child attributes
    • contact_emailstring | nullrequired
    • contact_namestring | nullrequired
    • contact_phonestring | nullrequired
    • created_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

    • deliveryOrderDeliveryOutput | nullrequired
      Child attributes
      • citystringrequired
      • country_codestringrequired

        e.g. GB

      • country_namestring | null
      • line1stringrequired
      • line2string | null
      • methodstring | null

        The supplier's delivery method code; empty for its default (Absolute Apparel: the default delivery code Presslane Suppliers set, as it needs one on every order).

      • namestringrequired

        Who or which business receives it.

      • plain_coverboolean

        Ship without the supplier's branding (default false).

      • postcodestringrequired
    • errorstring | nullrequired
    • idstringrequired

      e.g. ord_01jd…

    • linesarray of OrderLinerequired
      Child attributes
      • allow_backorderbooleanrequired
      • line_refstringrequired
      • quantityintegerrequired
      • supplier_skustringrequired

        The supplier's own code for the item, as sent.

      • supplier_variant_idstring | nullrequired
    • modestringrequired

      One of test, live

    • notesstring | nullrequired
    • referencestringrequired

      The account's reference; the supplier's purchase order number.

    • special_instructionsstring | nullrequired
    • statusstringrequired

      test: recorded, not sent. submitted: the supplier took it. failed: the supplier did not take it (see error); fix and send again. unconfirmed: no clear answer; check with GET /v1/orders/{id}?refresh=true before sending again. pending: being sent.

      One of test, pending, submitted, unconfirmed, failed

    • submitted_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • supplier_idstringrequired
    • supplier_order_refstring | nullrequired

      The supplier's own order number, when it gives one.

    • supplier_requestanyrequired

      The exact body sent to the supplier, or that test mode would have sent. Never holds credentials.

    • supplier_responseanyrequired

      The supplier's answer, when there was one.

    • updated_atstring (date-time)required

      e.g. 2026-11-09T08:00:00Z

    • warningsarray of stringrequired

      What the supplier said about an order it took, e.g. Ralawise's SkuNotFound (that line was not ordered) or UnableToAllocateSku (less was allocated than ordered, on a line without back-ordering). Empty otherwise.

  • has_morebooleanrequired
  • next_cursorstring | nullrequired

    Pass as starting_after for the next page.

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 429Too many requests (rate_limited); see Retry-After.
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/orders' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "data": [
    {
      "contact_email": "string",
      "contact_name": "string",
      "contact_phone": "string",
      "created_at": "2026-11-09T08:00:00Z",
      "delivery": {
        "city": "string",
        "country_code": "GB",
        "line1": "string",
        "name": "string",
        "postcode": "string"
      },
      "error": "string",
      "id": "ord_01jd…",
      "lines": [
        {
          "allow_backorder": false,
          "line_ref": "string",
          "quantity": 1,
          "supplier_sku": "string",
          "supplier_variant_id": "string"
        }
      ],
      "mode": "test",
      "notes": "string",
      "reference": "string",
      "special_instructions": "string",
      "status": "test",
      "submitted_at": "2026-11-09T08:00:00Z",
      "supplier_id": "string",
      "supplier_order_ref": "string",
      "supplier_request": null,
      "supplier_response": null,
      "updated_at": "2026-11-09T08:00:00Z",
      "warnings": [
        "UnableToAllocateSku: The SKU requested (GD057INBLS) was not found in sufficient quantity to satisfy the order. Ordered: 10, allocated: 7 (SKU)"
      ]
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}
Try it in the sandbox

Place an order with a supplier

post/v1/orders

Sent with the account's own login at the supplier (PUT …/connection first). Each line names a variant of the supplier or the supplier's own SKU. Suppliers whose API takes no orders (Laltex) answer 409 supplier_feature_unavailable. While the supplier is in test order mode the order is checked and recorded with the exact request that would be sent, and nothing is sent (status test). In live mode it is sent once and never retried: check status in the answer. A second live order with the same reference is refused (409) unless the first one failed. Send an Idempotency-Key to retry the request safely. Each supplier's own limits are checked first, in test mode too (400 invalid_request with errors): Ralawise needs contact_name and delivery, a reference of at most 20 characters and line references of at most 15; PenCarrie takes references of up to 14 letters, digits and underscores, one line per SKU, the same allow_backorder on every line, and deliveries in Great Britain; Absolute Apparel takes no notes or special_instructions, needs the same allow_backorder on every line and a delivery code (delivery.method, or the default Presslane Suppliers set). What a supplier says about an order it took is in warnings.

Called by
Account client
Scope
orders:write

Headers

  • Idempotency-Keystring

    A repeat within 24 hours returns the first response.

    at most 255 characters

Request body · application/json

  • contact_emailstring | null

    Where the supplier sends its confirmation.

  • contact_namestring | null

    Who at the business placed the order. Ralawise needs one.

    at most 100 characters · e.g. Jo Smith

  • contact_phonestring | null

    at most 40 characters · e.g. 07712 345678

  • deliveryOrderDelivery | null

    Where to deliver. Leave out for the supplier's default address for the account (Uneek). Ralawise needs one on every order.

    Child attributes
    • citystringrequired
    • country_codestringrequired

      e.g. GB

    • country_namestring | null
    • line1stringrequired
    • line2string | null
    • methodstring | null

      The supplier's delivery method code; empty for its default (Absolute Apparel: the default delivery code Presslane Suppliers set, as it needs one on every order).

    • namestringrequired

      Who or which business receives it.

    • plain_coverboolean

      Ship without the supplier's branding (default false).

    • postcodestringrequired
  • linesarray of objectrequired

    1–500 items

    Child attributes
    • allow_backorderboolean

      Let the supplier back-order what it cannot ship now (default false).

    • line_refstring

      Your line reference (default: the line number). Ralawise: up to 15 characters.

      at most 60 characters

    • quantityintegerrequired

      ≥ 1 · ≤ 100000

    • supplier_skustring

      The supplier's own code; sent as given. Takes precedence over the variant's SKU.

    • supplier_variant_idstring

      A variant of this supplier; its supplier SKU is sent.

  • notesstring | null

    at most 1000 characters

  • referencestringrequired

    Your purchase order number, up to 35 characters (Ralawise: 20). One live order per reference.

    at most 35 characters · e.g. PO-10442

  • special_instructionsstring | null

    at most 1000 characters

  • supplier_idstringrequired

    Supplier ID or slug.

Responses

201The order, with its status.Show
  • contact_emailstring | nullrequired
  • contact_namestring | nullrequired
  • contact_phonestring | nullrequired
  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • deliveryOrderDeliveryOutput | nullrequired
    Child attributes
    • citystringrequired
    • country_codestringrequired

      e.g. GB

    • country_namestring | null
    • line1stringrequired
    • line2string | null
    • methodstring | null

      The supplier's delivery method code; empty for its default (Absolute Apparel: the default delivery code Presslane Suppliers set, as it needs one on every order).

    • namestringrequired

      Who or which business receives it.

    • plain_coverboolean

      Ship without the supplier's branding (default false).

    • postcodestringrequired
  • errorstring | nullrequired
  • idstringrequired

    e.g. ord_01jd…

  • linesarray of OrderLinerequired
    Child attributes
    • allow_backorderbooleanrequired
    • line_refstringrequired
    • quantityintegerrequired
    • supplier_skustringrequired

      The supplier's own code for the item, as sent.

    • supplier_variant_idstring | nullrequired
  • modestringrequired

    One of test, live

  • notesstring | nullrequired
  • referencestringrequired

    The account's reference; the supplier's purchase order number.

  • special_instructionsstring | nullrequired
  • statusstringrequired

    test: recorded, not sent. submitted: the supplier took it. failed: the supplier did not take it (see error); fix and send again. unconfirmed: no clear answer; check with GET /v1/orders/{id}?refresh=true before sending again. pending: being sent.

    One of test, pending, submitted, unconfirmed, failed

  • submitted_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • supplier_idstringrequired
  • supplier_order_refstring | nullrequired

    The supplier's own order number, when it gives one.

  • supplier_requestanyrequired

    The exact body sent to the supplier, or that test mode would have sent. Never holds credentials.

  • supplier_responseanyrequired

    The supplier's answer, when there was one.

  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • warningsarray of stringrequired

    What the supplier said about an order it took, e.g. Ralawise's SkuNotFound (that line was not ordered) or UnableToAllocateSku (less was allocated than ordered, on a line without back-ordering). Empty otherwise.

  • 400The request is not valid (invalid_request).
  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
  • 503Not available on this deployment right now (service_unavailable).
Request
curl -sS -X POST 'https://suppliers.presslane.ai/v1/orders' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"contact_name":"Jo Smith","contact_phone":"07712 345678","delivery":{"city":"string","country_code":"GB","line1":"string","name":"string","postcode":"string"},"lines":[{"quantity":1}],"reference":"PO-10442","supplier_id":"string"}'
Response · 201
{
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "created_at": "2026-11-09T08:00:00Z",
  "delivery": {
    "city": "string",
    "country_code": "GB",
    "line1": "string",
    "name": "string",
    "postcode": "string"
  },
  "error": "string",
  "id": "ord_01jd…",
  "lines": [
    {
      "allow_backorder": false,
      "line_ref": "string",
      "quantity": 1,
      "supplier_sku": "string",
      "supplier_variant_id": "string"
    }
  ],
  "mode": "test",
  "notes": "string",
  "reference": "string",
  "special_instructions": "string",
  "status": "test",
  "submitted_at": "2026-11-09T08:00:00Z",
  "supplier_id": "string",
  "supplier_order_ref": "string",
  "supplier_request": null,
  "supplier_response": null,
  "updated_at": "2026-11-09T08:00:00Z",
  "warnings": [
    "UnableToAllocateSku: The SKU requested (GD057INBLS) was not found in sufficient quantity to satisfy the order. Ordered: 10, allocated: 7 (SKU)"
  ]
}
Try it in the sandbox

One order

get/v1/orders/{id}

With refresh=true, a live order is looked up at the supplier by its reference: an unconfirmed order found there becomes submitted, and supplier_order carries the supplier’s view (status, invoices, shipments, tracking). Suppliers whose API has no order history (Ralawise) answer 409 supplier_feature_unavailable; check on their website. Absolute Apparel is searched over the last 28 days, as far back as its API looks for a reference.

Called by
Account client
Scope
orders:read

Path parameters

  • idstringrequired

Query parameters

  • refreshstring

    Ask the supplier too (live orders).

    One of true, false

Responses

200The order.Show
  • contact_emailstring | nullrequired
  • contact_namestring | nullrequired
  • contact_phonestring | nullrequired
  • created_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • deliveryOrderDeliveryOutput | nullrequired
    Child attributes
    • citystringrequired
    • country_codestringrequired

      e.g. GB

    • country_namestring | null
    • line1stringrequired
    • line2string | null
    • methodstring | null

      The supplier's delivery method code; empty for its default (Absolute Apparel: the default delivery code Presslane Suppliers set, as it needs one on every order).

    • namestringrequired

      Who or which business receives it.

    • plain_coverboolean

      Ship without the supplier's branding (default false).

    • postcodestringrequired
  • errorstring | nullrequired
  • idstringrequired

    e.g. ord_01jd…

  • linesarray of OrderLinerequired
    Child attributes
    • allow_backorderbooleanrequired
    • line_refstringrequired
    • quantityintegerrequired
    • supplier_skustringrequired

      The supplier's own code for the item, as sent.

    • supplier_variant_idstring | nullrequired
  • modestringrequired

    One of test, live

  • notesstring | nullrequired
  • referencestringrequired

    The account's reference; the supplier's purchase order number.

  • special_instructionsstring | nullrequired
  • statusstringrequired

    test: recorded, not sent. submitted: the supplier took it. failed: the supplier did not take it (see error); fix and send again. unconfirmed: no clear answer; check with GET /v1/orders/{id}?refresh=true before sending again. pending: being sent.

    One of test, pending, submitted, unconfirmed, failed

  • submitted_atstring (date-time) | nullrequired

    e.g. 2026-11-09T08:00:00Z

  • supplier_idstringrequired
  • supplier_orderSupplierOrder | nullrequired

    With refresh=true on a live order: the supplier’s view of it.

    Child attributes
    • invoice_numbersarray of stringrequired
    • linesarray of objectrequired
      Child attributes
      • descriptionstring | nullrequired
      • quantitynumber | nullrequired
      • quantity_shippednumber | nullrequired
      • skustring | nullrequired
      • unit_pricenumber | nullrequired
    • order_numberstring | nullrequired
    • ordered_atstring (date-time) | nullrequired

      e.g. 2026-11-09T08:00:00Z

    • referencestring | nullrequired
    • shipment_numbersarray of stringrequired
    • statusstring | nullrequired

      The supplier's own status words.

    • supplier_datamap of anyrequired

      The supplier's record as it came, for fields not mapped above.

    • totalSupplierMoney | nullrequired
      Child attributes
      • amountnumberrequired
      • currencystring | nullrequired
    • tracking_numbersarray of stringrequired
  • supplier_order_refstring | nullrequired

    The supplier's own order number, when it gives one.

  • supplier_requestanyrequired

    The exact body sent to the supplier, or that test mode would have sent. Never holds credentials.

  • supplier_responseanyrequired

    The supplier's answer, when there was one.

  • updated_atstring (date-time)required

    e.g. 2026-11-09T08:00:00Z

  • warningsarray of stringrequired

    What the supplier said about an order it took, e.g. Ralawise's SkuNotFound (that line was not ordered) or UnableToAllocateSku (less was allocated than ordered, on a line without back-ordering). Empty otherwise.

  • 401Missing, expired or revoked token (invalid_token).
  • 403The token lacks a scope (insufficient_scope), the account is suspended (account_suspended), or the client kind cannot call this.
  • 404Not found (not_found).
  • 409Conflict, including a reused Idempotency-Key (idempotency_conflict).
  • 429Too many requests (rate_limited); see Retry-After.
  • 502The supplier's API did not answer (supplier_unavailable) or answered with an error (supplier_error).
Request
curl -sS -X GET 'https://suppliers.presslane.ai/v1/orders/{id}' \
  -H "Authorization: Bearer $TOKEN"
Response · 200
{
  "contact_email": "string",
  "contact_name": "string",
  "contact_phone": "string",
  "created_at": "2026-11-09T08:00:00Z",
  "delivery": {
    "city": "string",
    "country_code": "GB",
    "line1": "string",
    "name": "string",
    "postcode": "string"
  },
  "error": "string",
  "id": "ord_01jd…",
  "lines": [
    {
      "allow_backorder": false,
      "line_ref": "string",
      "quantity": 1,
      "supplier_sku": "string",
      "supplier_variant_id": "string"
    }
  ],
  "mode": "test",
  "notes": "string",
  "reference": "string",
  "special_instructions": "string",
  "status": "test",
  "submitted_at": "2026-11-09T08:00:00Z",
  "supplier_id": "string",
  "supplier_order": {
    "invoice_numbers": [
      "string"
    ],
    "lines": [
      {
        "description": "string",
        "quantity": 1,
        "quantity_shipped": 1,
        "sku": "string",
        "unit_price": 1
      }
    ],
    "order_number": "string",
    "ordered_at": "2026-11-09T08:00:00Z",
    "reference": "string",
    "shipment_numbers": [
      "string"
    ],
    "status": "string",
    "supplier_data": {},
    "total": {
      "amount": 1,
      "currency": "string"
    },
    "tracking_numbers": [
      "string"
    ]
  },
  "supplier_order_ref": "string",
  "supplier_request": null,
  "supplier_response": null,
  "updated_at": "2026-11-09T08:00:00Z",
  "warnings": [
    "UnableToAllocateSku: The SKU requested (GD057INBLS) was not found in sufficient quantity to satisfy the order. Ordered: 10, allocated: 7 (SKU)"
  ]
}
Try it in the sandbox