latestOpenAPI 3.0.22026-08-10312271.6 KB

c5159bc39a84

Orders

Update order

update order

put/orders/{orderId}

Path parameters

orderIdinteger required

spreadconnect order id

Request body

phonestring required

Phone used for the communication with the customer. Must not be blank.

emailstring email required

Email used for the communication with the customer. Must be a valid email address.

externalOrderReferencestring required

external order reference from merchant (you). Must not be blank.

externalOrderNamestring

external order name from merchant (you)

state'NEW' | 'CONFIRMED'

order state

customerTaxType'SALESTAX' | 'VAT' | 'NOT_TAXABLE'

tax type, salestax or vat

originstring

optional origin field

Example request

{
  "orderItems": [
    {
      "sku": "P1026247707A12S5",
      "externalOrderItemReference": "12810092145",
      "customerPrice": {
        "amount": 21.56,
        "currency": "USD"
      }
    }
  ],
  "oneTimeItems": [
    {
      "configurations": [
        {
          "image": {
            "url": "https://link.to.image",
            "designId": "1231"
          },
          "hotspot": "LEFT_CHEST"
        }
      ],
      "customerPricePerItem": {
        "amount": 21.56,
        "currency": "USD"
      }
    }
  ],
  "shipping": {
    "address": {
      "company": "Example Ltd.",
      "firstName": "Joshua",
      "lastName": "Anderson",
      "street": "1572 Roseytown Rd",
      "streetAnnex": "2nd Floor",
      "city": "Greensburg",
      "country": "US",
      "state": "AL",
      "zipCode": "15601"
    },
    "fromAddress": {
      "company": "Example Ltd.",
      "firstName": "Joshua",
      "lastName": "Anderson",
      "street": "1572 Roseytown Rd",
      "streetAnnex": "2nd Floor",
      "city": "Greensburg",
      "country": "US",
      "state": "AL",
      "zipCode": "15601"
    },
    "customerPrice": {
      "amount": 21.56,
      "currency": "USD"
    }
  },
  "billingAddress": {
    "company": "Example Ltd.",
    "firstName": "Joshua",
    "lastName": "Anderson",
    "street": "1572 Roseytown Rd",
    "streetAnnex": "2nd Floor",
    "city": "Greensburg",
    "country": "US",
    "state": "AL",
    "zipCode": "15601"
  },
  "phone": "+49 1520 1234567",
  "email": "joshua.anders@protonmail.ch",
  "externalOrderReference": "1722995712",
  "externalOrderName": "ORDER-12",
  "state": "CONFIRMED"
}

Response

OK

phonestring required

Phone used for the communication with the customer. Must not be blank.

emailstring email required

Email used for the communication with the customer. Must be a valid email address.

externalOrderReferencestring required

external order reference from merchant (you). Must not be blank.

externalOrderNamestring

external order name from merchant (you)

state'NEW' | 'CONFIRMED'

order state

customerTaxType'SALESTAX' | 'VAT' | 'NOT_TAXABLE'

tax type, salestax or vat

originstring

optional origin field

Example response

{
  "orderItems": [
    {
      "sku": "P1026247707A12S5",
      "externalOrderItemReference": "12810092145",
      "customerPrice": {
        "amount": 21.56,
        "currency": "USD"
      }
    }
  ],
  "oneTimeItems": [
    {
      "configurations": [
        {
          "image": {
            "url": "https://link.to.image",
            "designId": "1231"
          },
          "hotspot": "LEFT_CHEST"
        }
      ],
      "customerPricePerItem": {
        "amount": 21.56,
        "currency": "USD"
      }
    }
  ],
  "shipping": {
    "address": {
      "company": "Example Ltd.",
      "firstName": "Joshua",
      "lastName": "Anderson",
      "street": "1572 Roseytown Rd",
      "streetAnnex": "2nd Floor",
      "city": "Greensburg",
      "country": "US",
      "state": "AL",
      "zipCode": "15601"
    },
    "fromAddress": {
      "company": "Example Ltd.",
      "firstName": "Joshua",
      "lastName": "Anderson",
      "street": "1572 Roseytown Rd",
      "streetAnnex": "2nd Floor",
      "city": "Greensburg",
      "country": "US",
      "state": "AL",
      "zipCode": "15601"
    },
    "customerPrice": {
      "amount": 21.56,
      "currency": "USD"
    }
  },
  "billingAddress": {
    "company": "Example Ltd.",
    "firstName": "Joshua",
    "lastName": "Anderson",
    "street": "1572 Roseytown Rd",
    "streetAnnex": "2nd Floor",
    "city": "Greensburg",
    "country": "US",
    "state": "AL",
    "zipCode": "15601"
  },
  "phone": "+49 1520 1234567",
  "email": "joshua.anders@protonmail.ch",
  "externalOrderReference": "1722995712",
  "externalOrderName": "ORDER-12",
  "state": "CONFIRMED"
}