commerce

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-commerce"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a95d6f25-c648-492d-bcb5-a74907109222/social-card.svg?v=3e7ae33eec8b" alt="commerce" width="600" height="315"></a>
PUThttps://hermeticor.com/v1/commerce/stores/{storeId}/orders

Parameters

storeIdstringpathrequired

Request body

application/json
idstringrequired
emailstring
profileIdstring
statusstring
pending | paid | shipped | cancelled | refunded = paid
currencystringrequired
totalMinorinteger
discountMinorinteger
= 0
taxMinorinteger
= 0
shippingMinorinteger
= 0
promoCodestring
promoPoolIdstring
campaignIdstring
conversionSourcestring
trackingUrlstring
placedAtstring
landingPageIdstring
adRefstring
clickIdstring
utmobject
shippingAddressobject
Show child parameters
namestring
address1string
address2string
citystring
provincestring
provinceCodestring
postalCodestring
countrystring
countryCodestring
phonestring
companystring
billingAddressobject
Show child parameters
namestring
address1string
address2string
citystring
provincestring
provinceCodestring
postalCodestring
countrystring
countryCodestring
phonestring
companystring
orderUrlstring
financialStatusstring
fulfillmentStatusstring
linesLinesItem[]
= []
Show child parameters
idstringrequired
productIdstring
variantIdstring
titlestring
quantityinteger
= 1
priceMinorinteger
= 0
discountMinorinteger
= 0
{
  "id": "string",
  "email": "string",
  "profileId": "string",
  "status": "paid",
  "currency": "string",
  "totalMinor": 0,
  "discountMinor": 0,
  "taxMinor": 0,
  "shippingMinor": 0,
  "promoCode": "string",
  "promoPoolId": "string",
  "campaignId": "string",
  "conversionSource": "string",
  "trackingUrl": "string",
  "placedAt": "2024-01-01T00:00:00Z",
  "landingPageId": "string",
  "adRef": "string",
  "clickId": "string",
  "utm": {},
  "shippingAddress": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  },
  "billingAddress": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  },
  "orderUrl": "string",
  "financialStatus": "string",
  "fulfillmentStatus": "string",
  "lines": []
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/commerce/stores/{storeId}/orders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"string","email":"string","profileId":"string","status":"paid","currency":"string","totalMinor":0,"discountMinor":0,"taxMinor":0,"shippingMinor":0,"promoCode":"string","promoPoolId":"string","campaignId":"string","conversionSource":"string","trackingUrl":"string","placedAt":"2024-01-01T00:00:00Z","landingPageId":"string","adRef":"string","clickId":"string","utm":{},"shippingAddress":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"},"billingAddress":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"},"orderUrl":"string","financialStatus":"string","fulfillmentStatus":"string","lines":[]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "storeId": "string",
  "externalId": "string",
  "profileId": "string",
  "email": "string",
  "status": "pending",
  "currency": "string",
  "totalMinor": 0,
  "discountMinor": 0,
  "taxMinor": 0,
  "shippingMinor": 0,
  "refundedMinor": 0,
  "promoCode": "string",
  "promoPoolId": "string",
  "campaignId": "string",
  "conversionSource": "string",
  "trackingUrl": "string",
  "placedAt": "2024-01-01T00:00:00Z",
  "landingPageId": "string",
  "adRef": "string",
  "clickId": "string",
  "utm": {},
  "shippingAddress": {},
  "billingAddress": {},
  "orderUrl": "string",
  "financialStatus": "string",
  "fulfillmentStatus": "string",
  "shippedAt": "2024-01-01T00:00:00Z",
  "lines": [
    {
      "id": "string",
      "externalId": "string",
      "productId": "string",
      "variantId": "string",
      "title": "string",
      "quantity": 0,
      "priceMinor": 0,
      "discountMinor": 0
    }
  ]
}
Schema
idstringrequired
storeIdstringrequired
externalIdstringrequired
profileIdstringrequired
emailstringrequired
statusstringrequired
pending | paid | shipped | cancelled | refunded
currencystringrequired
totalMinorintegerrequired
discountMinorintegerrequired
taxMinorintegerrequired
shippingMinorintegerrequired
refundedMinorintegerrequired
promoCodestringrequired
promoPoolIdstringrequired
campaignIdstringrequired
conversionSourcestringrequired
trackingUrlstringrequired
placedAtstringrequired
landingPageIdstringrequired
adRefstringrequired
clickIdstringrequired
utmobjectrequired
shippingAddressobjectrequired
billingAddressobjectrequired
orderUrlstringrequired
financialStatusstringrequired
fulfillmentStatusstringrequired
shippedAtstringrequired
linesLinesItem2[]required
Show child parameters
idstringrequired
externalIdstringrequired
productIdstringrequired
variantIdstringrequired
titlestringrequired
quantityintegerrequired
priceMinorintegerrequired
discountMinorintegerrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PUT /v1/commerce/stores/{storeId}/orders

POSThttps://hermeticor.com/v1/commerce/stores/{storeId}/orders

Parameters

storeIdstringpathrequired

Request body

application/json
idstringrequired
emailstring
profileIdstring
statusstring
pending | paid | shipped | cancelled | refunded = paid
currencystringrequired
totalMinorinteger
discountMinorinteger
= 0
taxMinorinteger
= 0
shippingMinorinteger
= 0
promoCodestring
promoPoolIdstring
campaignIdstring
conversionSourcestring
trackingUrlstring
placedAtstring
landingPageIdstring
adRefstring
clickIdstring
utmobject
shippingAddressobject
Show child parameters
namestring
address1string
address2string
citystring
provincestring
provinceCodestring
postalCodestring
countrystring
countryCodestring
phonestring
companystring
billingAddressobject
Show child parameters
namestring
address1string
address2string
citystring
provincestring
provinceCodestring
postalCodestring
countrystring
countryCodestring
phonestring
companystring
orderUrlstring
financialStatusstring
fulfillmentStatusstring
linesLinesItem[]
= []
Show child parameters
idstringrequired
productIdstring
variantIdstring
titlestring
quantityinteger
= 1
priceMinorinteger
= 0
discountMinorinteger
= 0
{
  "id": "string",
  "email": "string",
  "profileId": "string",
  "status": "paid",
  "currency": "string",
  "totalMinor": 0,
  "discountMinor": 0,
  "taxMinor": 0,
  "shippingMinor": 0,
  "promoCode": "string",
  "promoPoolId": "string",
  "campaignId": "string",
  "conversionSource": "string",
  "trackingUrl": "string",
  "placedAt": "2024-01-01T00:00:00Z",
  "landingPageId": "string",
  "adRef": "string",
  "clickId": "string",
  "utm": {},
  "shippingAddress": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  },
  "billingAddress": {
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "province": "string",
    "provinceCode": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "string",
    "phone": "string",
    "company": "string"
  },
  "orderUrl": "string",
  "financialStatus": "string",
  "fulfillmentStatus": "string",
  "lines": []
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/commerce/stores/{storeId}/orders" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"string","email":"string","profileId":"string","status":"paid","currency":"string","totalMinor":0,"discountMinor":0,"taxMinor":0,"shippingMinor":0,"promoCode":"string","promoPoolId":"string","campaignId":"string","conversionSource":"string","trackingUrl":"string","placedAt":"2024-01-01T00:00:00Z","landingPageId":"string","adRef":"string","clickId":"string","utm":{},"shippingAddress":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"},"billingAddress":{"name":"string","address1":"string","address2":"string","city":"string","province":"string","provinceCode":"string","postalCode":"string","country":"string","countryCode":"string","phone":"string","company":"string"},"orderUrl":"string","financialStatus":"string","fulfillmentStatus":"string","lines":[]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response

Same as 200 · PUT /v1/commerce/stores/{storeId}/orders

4XX Default Response

Same as 4XX · PUT /v1/commerce/stores/{storeId}/orders

5XX Default Response

Same as 4XX · PUT /v1/commerce/stores/{storeId}/orders

Updated