GOgolocad
Custom Webstore (B2C)

Create Order

Create Order.<br/>Note:- Id Returned in Response should be saved as this will be used to query/update Order

post/openapi/{version}/customwebstore/orders/

Request

  • Base URL
    https://base_url
  • Auth
    none declared. Required headers: connection-id

Path parameters

versionstring required

Query parameters

update-if-existsboolean

When true, if an order with the same unique_order_identifier already exists for this connection, the request is treated as an update instead of failing with a duplicate error. If omitted, falls back to default configuration.

Headers

connection-idstring required

Custom webstore connection id.

Request body

idinteger required
unique_order_identifierstring required
order_referencestring nullable
payment_method'CASH_ON_DELIVERY' | 'DEBIT_CARD' | 'CREDIT_CARD' | 'DIGITAL_WALLET' | 'OTHER' required
  • CASH_ON_DELIVERY - Cash On Delivery
  • DEBIT_CARD - Debit Card
  • CREDIT_CARD - Credit Card
  • DIGITAL_WALLET - Digital Wallet
  • OTHER - Other
cod_amountstring decimal nullable
total_pricestring decimal
created_atstring date-time required
updated_atstring date-time required
payment_verifiedboolean

Indicates whether the payment has been successfully verified or not. Default is True. Order will be in UNPAID status if False.

is_giftboolean
gift_messagestring nullable
is_pausedboolean nullable
is_ddpboolean nullable

Indicates whether Delivery Duty paid or not.

has_ddp_infoboolean nullable

Indicates whether Delivery Duty info is available or not.

channel_namestring nullable

Sales channel or marketplace from which the order originated. Must be one of: amazon, bbo, capillary, ebay, ginee, kumu, lazada, noon, salla, shopee, shopify, temu, tiktok, tokopedia, wix, woocommerce, zalora, zid, walmart, etsy, target, flipkart, namshi, instagram, whatsapp, shein, website, other

Response

successboolean
messagestring required

Changes

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