Sales Invoice Shipment

The sales invoice shipment resource.

Basehttps://rest.carbon.ms/salesInvoiceShipment

GET/salesInvoiceShipment

List sales invoice shipments

Retrieve a paginated list of sales invoice shipments. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/salesInvoiceShipment

curl --request GET \
  --url 'https://rest.carbon.ms/salesInvoiceShipment?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "shippingCost": 0,
    "customFields": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "locationId": "xyz789",
    "shippingMethodId": "xyz789",
    "shippingTermId": "xyz789"
  }
]

GET/salesInvoiceShipment

Retrieve a sales invoice shipment

Fetch a single sales invoice shipment by filtering on `id`.

Query parameters

idstring

Match on the sales invoice shipment's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/salesInvoiceShipment

curl --request GET \
  --url 'https://rest.carbon.ms/salesInvoiceShipment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "shippingCost": 0,
  "customFields": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789"
}

POST/salesInvoiceShipment

Create a sales invoice shipment

Create a new sales invoice shipment.

Body parameters

shippingCostnumberrequired

locationIdstring

shippingMethodIdstring

shippingTermIdstring

customFieldsobjectrequired

companyIdstring

References company.id

incotermstring

incotermLocationstring

POSThttps://rest.carbon.ms/salesInvoiceShipment

curl --request POST \
  --url https://rest.carbon.ms/salesInvoiceShipment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"shippingCost":0,"customFields":"string"}'

Response

{
  "id": "abc123def456",
  "shippingCost": 0,
  "customFields": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789"
}

PATCH/salesInvoiceShipment

Update a sales invoice shipment

Update an existing sales invoice shipment, matched on `id`.

Body parameters

shippingCostnumberrequired

locationIdstring

shippingMethodIdstring

shippingTermIdstring

customFieldsobjectrequired

companyIdstring

References company.id

incotermstring

incotermLocationstring

PATCHhttps://rest.carbon.ms/salesInvoiceShipment

curl --request PATCH \
  --url 'https://rest.carbon.ms/salesInvoiceShipment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"shippingCost":0}'

Response

{
  "id": "abc123def456",
  "shippingCost": 0,
  "customFields": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789"
}

DELETE/salesInvoiceShipment

Delete a sales invoice shipment

Delete a sales invoice shipment, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the sales invoice shipment to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/salesInvoiceShipment

curl --request DELETE \
  --url 'https://rest.carbon.ms/salesInvoiceShipment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content