Dokumentation Entwickler API

Shipping Address Ressource

Aktualisiert am 16.03.2017

Shipping Address Ressource


Attention

Shipping Address resources are read-only by default. Please contact us at [email protected]

/* */ if you need write permissions.

Get Shipping Addresses

GET /api/shipping_addresses.json

  • GET /api/shipping_addresses.json will return the first 150 (default limit) shipping addresses. You can increase the limit to a maximum of 250 shipping addresses.


Example

Shipping Address Ressource

$ curl -s \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u APP_API_KEY:APP_API_PASSWORD \
-X GET \
http://SHOP_SUBDOMAIN.versacommerce.de/api/shipping_addresses.json

Shipping Address Ressource

Status: 200 OK

[
{
"address": {
"city": "Welver",
"company": "d1 group, e-business GmbH",
"country": "DE",
"customer_id": 1000,
"email": "customer1@versacommerce.de",
"extension": "",
"firstname": "Eduard",
"id": 100,
"lastname": "Siebert",
"option_01": "",
"option_02": "",
"option_03": "",
"order_id": 28761,
"phone": "+49 511 1659 800",
"state": "unbekannt",
"street": "Zwischen den Hölzern",
"streetnumber": "1a",
"title": "Herr",
zipcode": "59514
}
},
{
"address": {
"city": "Welver",
"company": "d1 group, e-business GmbH",
"country": "DE",
"customer_id": 1001,
"email": "customer2@versacommerce.de",
"extension": "",
"firstname": "Björn",
"id": 101,
"lastname": "Dorra",
"option_01": "",
"option_02": "",
"option_03": "",
"order_id": 28761,
"phone": "+49 511 1659 800",
"state": "unbekannt",
"street": "Zwischen den Hölzern",
"streetnumber": "1a",
"title": "Herr",
zipcode": "59514
}
}
]

Shipping Address Ressource

Get Shipping Address

GET /api/shipping_addresses/:shipping_address_id.json

  • GET /api/shipping_addresses/:shipping_address_id.json will return the specified shipping address.

Example

Shipping Address Ressource

$ curl -s \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u APP_API_KEY:APP_API_PASSWORD \
-X GET \
http://SHOP_SUBDOMAIN.versacommerce.de/api/shipping_addresses/:shipping_address_id.json

Shipping Address Ressource

Status: 200 OK

{
"address": {
"city": "Welver",
"company": "d1 group, e-business GmbH",
"country": "DE",
"customer_id": 1000,
"email": "customer1@versacommerce.de",
"extension": "",
"firstname": "Eduard",
"id": 100,
"lastname": "Siebert",
"option_01": "",
"option_02": "",
"option_03": "",
"order_id": 28761,
"phone": "+49 511 1659 800",
"state": "unbekannt",
"street": "Zwischen den Hölzern",
"streetnumber": "1a",
"title": "Herr",
zipcode": "59514
}
}

Shipping Address Ressource

Get Shipping Address Count

GET /api/shipping_addresses/count.json

  • GET /api/shipping_addresses/count.json will return the shipping addresses count.

Example

Shipping Address Ressource

$ curl -s \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u APP_API_KEY:APP_API_PASSWORD \
-X GET \
http://SHOP_SUBDOMAIN.versacommerce.de/api/shipping_addresses/count.json

Shipping Address Ressource

Status: 200 OK

{
"count": 45
}