ShopRpc

Create a new order. On success, a confirmation email is sent to the provided contact email address.

post/api/grpc-json/v1/shop/orders

Request

  • Base URL: https://localhost:5001
  • URL: https://localhost:5001/api/grpc-json/v1/shop/orders
  • Auth: none declared

Headers

X-Sportident-Client-Idstring

Client identifier to determine the source of a request.

Request body

oidinteger

Immutable. Object identifier assigned by the backend. Leave empty (0) when creating a new order.

orderNumberstring

Immutable. Generated by the backend. Leave empty ("") when creating a new order.

billingAddressIsSameAsShippingAddressboolean

Set to true if billing address is identical to the shipping address. The content of billingAddress is ignored by the backend if this flag is set to true.

discountCodesstring[]

Optional. List of discount codes. Note that the discount codes should be validated before submitting a create order request, as the order will be rejected if one or multiple of the provided discount codes are invalid.

retailerCustomerOrderReferencestring

Optional. Customer order reference. Passed along to the commission field in the Weclapp quotation, sales order and invoice. Helps retailers to associate their internal customer orders with the Weclapp order.

notesstring

Optional. Notes provided by the customer.

Response

Success

oidinteger

Immutable. Object identifier assigned by the backend. Leave empty (0) when creating a new order.

orderNumberstring

Immutable. Generated by the backend. Leave empty ("") when creating a new order.

billingAddressIsSameAsShippingAddressboolean

Set to true if billing address is identical to the shipping address. The content of billingAddress is ignored by the backend if this flag is set to true.

discountCodesstring[]

Optional. List of discount codes. Note that the discount codes should be validated before submitting a create order request, as the order will be rejected if one or multiple of the provided discount codes are invalid.

retailerCustomerOrderReferencestring

Optional. Customer order reference. Passed along to the commission field in the Weclapp quotation, sales order and invoice. Helps retailers to associate their internal customer orders with the Weclapp order.

notesstring

Optional. Notes provided by the customer.

Changes

No recorded changes to this operation across all 1 revision of this API.