younifyd
Menu

Add shipping information (POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info)

Add shipping information

POST/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info

Use it in a workflow

  1. Add a step and choose the Klarna connector.
  2. Pick the Add shipping information (POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info) action (under Order Management).
  3. Fill in the fields below, then reference the result from later steps as {{addShippingInformationPostOrdermanagementV1OrdersOrderIdCapturesCaptureIdShippingInfo.response.data}}.

Request

Path parameters

order_idstringrequired

Order id

capture_idstringrequired

Capture id

Headers

Klarna-Idempotency-Keystring

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 body

Enter the body as JSON in the step's Body field.

shipping_infoarray<object>required

New shipping info. Maximum: 500 items.

return_shipping_companystring

Identifier of the shipping company for the return shipment. The value should be a valid SHIPPING_COMPANY from the [Carrier list](https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/).

return_tracking_numberstring

Tracking number for the return shipment. Maximum 100 characters.

return_tracking_uristring

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

shipping_companystring

Identifier of the shipping company. The value should be a valid SHIPPING_COMPANY from the [Carrier list](https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/).

shipping_methodstring

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

tracking_numberstring

Tracking number for the shipment. Maximum 100 characters.

tracking_uristring

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

json
{
  "shipping_info": [
    {
      "return_shipping_company": "dhl-express",
      "return_tracking_number": "93456415674545679888",
      "return_tracking_uri": "http://shipping.example/findmypackage?93456415674545679888",
      "shipping_company": "dhl-express",
      "shipping_method": "Home",
      "tracking_number": "63456415674545679874",
      "tracking_uri": "http://shipping.example/findmypackage?63456415674545679874"
    }
  ]
}

Response

Returns 204 with a any. Read it in later steps with {{addShippingInformationPostOrdermanagementV1OrdersOrderIdCapturesCaptureIdShippingInfo.response.data.<field>}}.

Need more? See the Klarna guide for connection setup and behaviour shared by every action.