Add shipping information

https://api.kustom.co/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info

Add shipping info to a capture. Read more on Adding shipping info

Parameters

Request body

204

403

404

409

Example

Parameters3 fields

• order_idstring · uuidrequiredin path

  Order id

• capture_idstringrequiredin path

  Capture id

• Klarna-Idempotency-Keystringoptionalin header

  This header will guarantee the idempotency of the operation. The key should be unique and is recommended to be a UUID version 4. Retries of requests are safe to be applied in case of errors such as network errors, socket errors and timeouts. Input values of the operation are disregarded when evaluating the idempotency of the operation, only the key matters.

Request body8 fields

• shipping_info[]array<object>required

  New shipping info. Maximum: 500 items.

  7 fields in shipping_info

  • return_shipping_companystringoptional

    Name of the shipping company for the return shipment (as specific as possible). Maximum 100 characters. Example: ‘DHL SE’ and not only ‘DHL’

  • return_tracking_numberstringoptional

    Tracking number for the return shipment. Maximum 100 characters.

  • return_tracking_uristringoptional

    URL where the customer can track the return shipment. Maximum 1024 characters.

  • shipping_companystringoptional

    Name of the shipping company (as specific as possible). Maximum 100 characters. Example: ‘DHL SE’ and not only ‘DHL’

  • shipping_methodstringoptional

    Shipping method. Allowed values matches (PickUpStore|Home|BoxReg|BoxUnreg|PickUpPoint|Own|Postal|DHLPackstation|Digital|Undefined|PickUpWarehouse|ClickCollect|PalletDelivery)

  • tracking_numberstringoptional

    Tracking number for the shipment. Maximum 100 characters.

  • tracking_uristringoptional

    URI where the customer can track their shipment. Maximum 1024 characters.

204

Response0 fields

Shipping information was appended.

No response body — this status returns headers only.

403

Response3 fields

Order has no captures.

• correlation_idstringoptional

  Correlation id. For searching logs.

• error_codestringoptional

  Error code

• error_messages[]array<string>optional

  Error messages

404

Response3 fields

Order or capture not found.

• correlation_idstringoptional

  Correlation id. For searching logs.

• error_codestringoptional

  Error code

• error_messages[]array<string>optional

  Error messages

409

Response0 fields

Conflict

No response body — this status returns headers only.

Errors

Code	Status	What it means	Retry
NO_SUCH_CAPTURE	404	No capture exists with that id on this order.	Never retry

POST https://api.kustom.co/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info

RequestBodyResponse204403404409

Request body· application/json

{
  "shipping_info": [
    {
      "return_shipping_company": "DHL SE",
      "return_tracking_number": 93456415674545680000,
      "return_tracking_uri": "http://shipping.example/findmypackage?93456415674545679888",
      "shipping_company": "DHL SE",
      "shipping_method": "Home",
      "tracking_number": 63456415674545680000,
      "tracking_uri": "http://shipping.example/findmypackage?63456415674545679874"
    }
  ]
}

13 linesCopy

Response 204· Shipping information was appended.

No response body.

This status returns headers only — there is nothing to parse.

—

Response 403· Order has no captures.

{
  "correlation_id": "66782175-ae05-44fc-9eb3-eeceadbad271",
  "error_code": "NOT_ALLOWED",
  "error_messages": [
    "<string>"
  ]
}

7 linesCopy

Response 404· Order or capture not found.

{
  "correlation_id": "66782175-ae05-44fc-9eb3-eeceadbad271",
  "error_code": "NO_SUCH_ORDER",
  "error_messages": [
    "<string>"
  ]
}

7 linesCopy

Response 409· Conflict

"<string>"

1 linesCopy