WinShopAPI docs

Create an order delivery address

Stores a delivery address that orders can point at, and returns 201 with a `Location` header for its detail. The response body is empty — read the address back from that URL. Requires `Permissions.OrderDeliveryAddress.Create`.

POST
/api/documents/orders/delivery-address

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. body
account?string
Lengthlength <= 50
bank?string
Lengthlength <= 50
companyIdentificationNumber?string
Lengthlength <= 15
countryId?integer
Formatint32
deliveryAddress?
documentNumber?string
dpdCollectionDate?|
Formatdate-time
dpdDepot?string
Lengthlength <= 20
dpdParcelShopId?string
Lengthlength <= 25
dpdRoute?string
Lengthlength <= 10
dpdSendDepot?string
Lengthlength <= 50
finalRecipient?
homelandAbroadOwn?integer
Formatint32
ibanCode?string
Lengthlength <= 35
invoicingAddress?
note?string
swiftCode?string
Lengthlength <= 20
vatPayer?boolean
vatRegistrationNumber?string
Lengthlength <= 15
zasilkovnaLocationId?string
Lengthlength <= 50
zasilkovnaReverseTrackingCode?string
Lengthlength <= 100

Response Body

response?unknownapplication/octet-stream
curl -X POST 'https://<your-instance>/api/documents/orders/delivery-address' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
null