Create a new Order

Creates an order in checkout state

SecurityBearer

Request

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

Order

reference	string External order reference
	object Order state
culture	string^[A-Za-z]{2,3}(?:-[A-Za-z]{2,2})*$ Order Culture, RFC-1766
currency	string^[A-Za-z]{3,3}$ Order Currency, ISO 4217 alpha-3.
country	string^[A-Za-z]{2,2}$ Order Country. ISO 3166 alpha-2.
	object Order cart
	object Customer information
	Array of objects (Consent) Order consents
	Array of objects (Callback) Order actions are called in order to complete an action, such as 'Validate'. If provided the action is not completed if the response is not successful (e.g. http status code 400), note however that in case of a time constraint the action might be completed without a successful response.
	Array of objects (Hook) Hooks, added by a separate endpoint.
	Array of objects (Notification) Order notifications are called after an event has occurred, such as order reaching 'Completed' state.
	object Order total including shipping fees
	object Allows you to store any custom attributes for the order.

Responses

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

post/api/v0/checkout/orders

Request samples

Payload
curl

application/json

{"reference": "string",
"state": {"currentStatus": "checkout"
},
"culture": "string",
"currency": "string",
"country": "string",
"cart": {"reference": "string",
"items": [{"id": "ci_FpEzyBvBBUyKxkeNriFUxZOCje",
"reference": "string",
"name": "T-Shirt XL",
"sku": "A000123",
"productType": "physical",
"items": [{ }
],
"url": "https://example.com/products/A000123",
"imageUrl": "https://example.com/products/A000123/images/1",
"quantity": 2,
"unit": "st",
"price": {"includingVat": 1234,
"excludingVat": 987.2
},
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"originalTotal": {"includingVat": 1234,
"excludingVat": 987.2
},
"vatRate": 0.25,
"discounts": [{"type": "item",
"name": "string",
"code": "string",
"value": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
}
],
"logistics": {"weight": 2500,
"height": 100,
"width": 50,
"length": 200
},
"attributes": {"property1": null,
"property2": null
}
}
],
"discounts": [{"type": "item",
"name": "string",
"code": "string",
"value": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
}
],
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
},
"customer": {"billing": {"type": "Person",
"givenName": "Rosalinainho",
"familyName": "Undulatsson",
"careOf": "Olleinho Jyckesson",
"reference": "string",
"organizationName": "Storm",
"streetAddress": "Adaptivevägen 18",
"streetAddress2": "Lgh 1203",
"postalCode": "955 60",
"city": "Boden",
"region": "Norrbotten",
"country": "SE",
"phone": "0753892233",
"email": "rosalinainho.undulatsson@example.com",
"nationalIdentificationNumber": "890201-3286",
"organizationIdentificationNumber": "212000-1355",
"attributes": {"property1": null,
"property2": null
}
},
"shipping": {"type": "Person",
"givenName": "Rosalinainho",
"familyName": "Undulatsson",
"careOf": "Olleinho Jyckesson",
"reference": "string",
"organizationName": "Storm",
"streetAddress": "Adaptivevägen 18",
"streetAddress2": "Lgh 1203",
"postalCode": "955 60",
"city": "Boden",
"region": "Norrbotten",
"country": "SE",
"phone": "0753892233",
"email": "rosalinainho.undulatsson@example.com",
"nationalIdentificationNumber": "890201-3286",
"organizationIdentificationNumber": "212000-1355",
"attributes": {"property1": null,
"property2": null
}
},
"type": "Person",
"attributes": {"property1": null,
"property2": null
}
},
"consents": [{"id": "ci_newsleter",
"checked": true,
"text": "string",
"required": true
}
],
"validations": [{"adapterId": "jetshop_adapter",
"url": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"
}
],
"hooks": [{"adapterId": "jetshop_adapter",
"subscribeTo": "string",
"target": "string",
"invoke": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback",
"version": "v0"
}
],
"notifications": [{"id": "ocGooDddTOjKOuFmNnkEozEpfuTh",
"adapterId": "jetshop_adapter",
"reference": "PuXCudQEiWTOHvquGGolFUVOuy",
"description": "Export payment information to Jetshop when order has been completed.",
"scope": "/state/currentStatus",
"schema": {"const": "completed"
},
"invoke": "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback",
"version": "v0",
"delay": 0
}
],
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
}

Response samples

application/json

"string"