Create Order Shipping

Creates a order shipping

SecurityBearer

Request

path Parameters

order_id

required

string

Order identifier

header Parameters

x-merchant required	string non-empty Merchant identifier. Example: norce
x-channel required	string non-empty Channel identifier Example: 1

Request Body schema: application/json

Shipping

merchant	string Merchant identifier.
channel	string Channel identifier
state	string Current state of the shipping. Enum: "intent" "removed" "processing" "failed" "confirmed"
reference	string External reference to shipping.
tmsReference	string TMS Reference.
orderId	string ID of the order.
adapterId	string Adapter ID
name	string Descriptive name of the shipping.
required	object Total price of the shipping.
vatRate required	number <double> Value-added tax. 25% would be input as 0.25.
	object Delivery details.
	Array of objects (Addon) Shipping addons.
	object Allows you to store any custom attributes for the shipping.

Responses

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/api/v0/checkout/orders/{order_id}/shippings

Request samples

Payload
curl

application/json

{"merchant": "norce",
"channel": "1",
"state": "intent",
"reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
"tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
"orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
"adapterId": "ingrid-shipping-adapter",
"name": "PostNord MyPack Home",
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"vatRate": 0.25,
"deliveryDetails": {"carrier": "string",
"class": "string",
"product": {"reference": "string",
"name": "string"
},
"pickupLocation": {"reference": "string",
"name": "string",
"address": {"streetAddress": "Adaptivevägen 18",
"city": "Boden",
"postalCode": "955 60",
"country": "SE"
}
}
},
"addons": [{"reference": "string",
"price": 0
}
],
"attributes": {"property1": null,
"property2": null
}
}

Response samples

application/json

{"id": "string"
}