Skip to content
トレカクラウド
Esc
↑↓navigate↵open⌘Jpreview

Ship a shipment

Named lines use saleAmountMinor; others use their JPY market value. A line with no price fails with sale_amount_required. Non-JPY requires every line to be priced. saleCurrency requires items, with unique commitment IDs on this shipment. In addition to inventory:read, this needs its operation scope and the approving member’s inventory.write permission.

POST/inventory/shipments/{id}/ship
Authorization
AuthorizationOAuth2 access token · headerrequired

Authorization code flow (PKCE S256 required). Send resource=https://api.toreca-cloud.com/partner/v1 with the authorization, token and refresh requests. Access tokens last 15 minutes; refresh tokens last 90 days and rotate on every refresh.

Scopes:inventory:readinventory:write
Path parameters
idstring<uuid>required
Request body
requiredapplication/json
trackingNumberstring
min length 1 · max length 100
saleCurrencystring
matches ^[A-Z]{3}$
itemsobject[]
min items 1 · max items 200
Show properties
Array of object
commitmentIdstring<uuid>required
saleAmountMinorintegerrequired
min 0 · max 10000000000
Responses
200

Success

idstring<uuid>required
createdAtstring<date-time>required
updatedAtstring<date-time>required
orderNumberstringrequired
statusstringrequired
Allowed:reservedawaiting_shipmentshippedcancelled
versionintegerrequired
destinationLabelstringrequired
externalRefstring | nullrequired
Show properties
One of:
string
string
null
null
trackingNumberstring | nullrequired
Show properties
One of:
string
string
null
null
shippedAtstring<date-time> | nullrequired
Show properties
One of:
string<date-time>
string<date-time>
null
null
itemsobject[]required
Show properties
Array of object
commitmentIdstring<uuid> | nullrequired
Show properties
One of:
string<uuid>
string<uuid>
null
null
inventoryItemIdstring<uuid>required
assetNumberstringrequired
statusstringrequired
saleobject | nullrequired
Show properties
One of:
object
amountMinorintegerrequired
currencystringrequired
sourcestringrequired
null
null
400

invalid_request: a parameter is invalid.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

requestIdstring<uuid>
inventoryItemIdsstring<uuid>[]
holdIdsstring<uuid>[]
commitmentIdsstring<uuid>[]
401

invalid_token: the token is missing, expired, or for another resource.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

requestIdstring<uuid>
inventoryItemIdsstring<uuid>[]
holdIdsstring<uuid>[]
commitmentIdsstring<uuid>[]
403

One of insufficient_scope, connection_revoked, client_disabled or forbidden.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

requestIdstring<uuid>
inventoryItemIdsstring<uuid>[]
holdIdsstring<uuid>[]
commitmentIdsstring<uuid>[]
404

not_found

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

requestIdstring<uuid>
inventoryItemIdsstring<uuid>[]
holdIdsstring<uuid>[]
commitmentIdsstring<uuid>[]
409

Conflict, reused requestId or receipt not confirmed

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

requestIdstring<uuid>
inventoryItemIdsstring<uuid>[]
holdIdsstring<uuid>[]
commitmentIdsstring<uuid>[]
422

The state, target or value refuses the operation. Inspect error and affected IDs.

errorstringrequired

The error code

scopestring

With insufficient_scope, the missing scope

requestIdstring<uuid>
inventoryItemIdsstring<uuid>[]
holdIdsstring<uuid>[]
commitmentIdsstring<uuid>[]
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.toreca-cloud.com/partner/v1/inventory/shipments/497f6eca-6276-4993-bfeb-53cbbbba6f08/ship' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "trackingNumber": "string",
  "saleCurrency": "string",
  "items": [
    {
      "commitmentId": "4e1ecf7c-8127-4207-92b0-010ff43ff54d",
      "saleAmountMinor": 0
    }
  ]
}'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "orderNumber": "string",
  "status": "reserved",
  "version": 0,
  "destinationLabel": "string",
  "externalRef": "string",
  "trackingNumber": "string",
  "shippedAt": "2019-08-24T14:15:22Z",
  "items": [
    {
      "commitmentId": "4e1ecf7c-8127-4207-92b0-010ff43ff54d",
      "inventoryItemId": "ef1bc09e-447a-46aa-a9d9-d86e3d490831",
      "assetNumber": "string",
      "status": "string",
      "sale": {
        "amountMinor": 0,
        "currency": "string",
        "source": "string"
      }
    }
  ]
}

Was this page helpful?