Skip to content

Order head change

Request

You can change basic info (head) of order with this method.

Please note following rules

  • email .. maxLength 100 characters

  • phone .. maxLength 32 characters

  • billingAddress.company .. maxLength 255 characters

  • billingAddress.fullName .. maxLength 255 characters

  • billingAddress.street .. maxLength 255 characters

  • billingAddress.houseNumber .. maxLength 255 characters

  • billingAddress.city .. maxLength 255 characters

  • billingAddress.district .. maxLength 255 characters

  • billingAddress.additional .. maxLength 255 characters

  • billingAddress.zip .. maxLength 255 characters

  • billingAddress.regionName .. maxLength 255 characters

  • billingAddress.regionShortcut .. maxLength 255 characters

  • billingAddress.companyId .. maxLength 18 characters

  • billingAddress.vatId .. maxLength 16 characters

  • billingAddress.taxId .. maxLength 16 characters

  • deliveryAddress.company .. maxLength 255 characters

  • deliveryAddress.fullName .. maxLength 255 characters

  • deliveryAddress.street .. maxLength 255 characters

  • deliveryAddress.houseNumber .. maxLength 255 characters

  • deliveryAddress.city .. maxLength 255 characters

  • deliveryAddress.district .. maxLength 255 characters

  • deliveryAddress.additional .. maxLength 255 characters

  • deliveryAddress.zip .. maxLength 255 characters

  • deliveryAddress.regionName .. maxLength 255 characters

  • deliveryAddress.regionShortcut .. maxLength 255 characters

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
codestringrequired

order code (number)

Example:2018000012
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X PATCH \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/orders/2018000012/head \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "creationTime": "2018-01-21T14:15:47+0100",
      "email": "foo@bar.cz",
      "phone": "+420123456789",
      "birthDate": "1990-01-01",
      "customerGuid": "1b02cb8e-d7b5-11e0-9a5c-feab5ed617ed",
      "addressesEqual": true,
      "billingAddress": {
        "company": "Smith & Smith",
        "fullName": "John Doe",
        "street": "Main Street",
        "houseNumber": "123",
        "city": "Flat Country",
        "district": "Bohemia",
        "additional": "3rd floor",
        "zip": "123 00",
        "countryCode": "CZ",
        "regionName": "Central Bohemia",
        "regionShortcut": "SC",
        "companyId": "123456",
        "vatId": "CZ123456",
        "taxId": "CZ123456"
      },
      "deliveryAddress": {
        "company": "Smith & Smith",
        "fullName": "John Doe",
        "street": "Main Street",
        "houseNumber": "123",
        "city": "Flat Country",
        "district": "Bohemia",
        "additional": "3rd floor",
        "zip": "123 00",
        "countryCode": "CZ",
        "regionName": "Central Bohemia",
        "regionShortcut": "SC"
      }
    }
  }'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "order": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}