Exportieren ▼

VIA-Connect - REST API » SalesOrders » SalesOrders Beispiele

SalesOrders Beispiele

Zuletzt geändert von Thomas Hoffmann am 2017/11/21 15:17

Kommentare (0) · Anhänge (0) · Historie

Inhalt

Bestellungen abrufen
ForeignOrderId setzen
- Request
- Response
Bezahlstatus setzen
Versandstatus setzen

Jegliches Änderung von Properties für SalesOrders kann nur für einzelne Properties vorgenommen werden.
Daher sind Änderungen ausschliesslich mit solchen Requests möglich:

PUT http://sandbox.api.via.de/publicapi/v1/api.svc/SalesOrders(1L)/Property

Jede Änderung auf ein ganzes Entity wird mit einem Error abgewiesen.

Beispiele für solche Requests finden Sie weiter unten.

OData ermöglicht durch Verwendung von Query String Optionen Navigation Properties zu kombinieren.

$expand

Mit der oData Query Option $expand können alle Relationen zu SalesOrders zusammen abgerufen werden.

$filter

Mit der oData Query Option $filter können bestimmte Entities abgerufen werden.

Achten Sie bitte darauf, dass die Request URL vor dem Absenden URL-Enkodiert wird.

Bestellungen abrufen

Alle Bestelldaten abrufen

Im unteren Beispiel werden alle assoziierten EntitySets mittels der Navigation Properties vom EntitySet SalesOrders abrufen.

GET http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders()?$expand=SalesOrderItems,Buyer,Address,ShippingAddress

Alle neuen Bestellungen abrufen

ForeignOrderId

Das unten aufgeführte Beispiel gibt alle Bestellungen zurück, die noch keine "ForeignOrderId" vom Fremdsystem zugewiesen haben.

GET http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders()?$expand=SalesOrderItems,Buyer,Address,ShippingAddress&$filter=(ForeignOrderId+eq+null)+or+(ForeignOrderId+eq+'')

Alle geänderten Bestellungen abrufen

Wenn sich seitens eBay eine Bestellung ändert (z.B. Bezahlt-Status, Versendet-Status), so können diese Bestellungen mit folgendem Requerst abgerufen werden.

GET http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders()?$expand=SalesOrderItems,Buyer,Address,ShippingAddress&$filter=(EbayModificationDate+gt+DateTime'{DATUM}'+and+EbayModificationDate+ne+null)

{DATUM}
Geben Sie hier ein beliebiges Datum als UTC an. Das Datum muss in folgendem Format übergeben werden: yyyy-MM-ddTHH:mm:ss => 2013-09-16T07:21:12

Mit dem obigen Beispieldatum würden alle Bestellungen abgeholt, die sich nach 16.09.2013 07:21:12 geändert haben.

ForeignOrderId setzen

Request

Request Methode

PUT http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/ForeignOrderId

XML
JSON

Request-HTTP-Header

Content-Type:           application/xml
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request-Body

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ForeignOrderId p1:type="Edm.String" xmlns:p1="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices">Externe ForeignOrderId</ForeignOrderId>

Request-HTTP-Header

Content-Type:           application/json
Accept:                 application/json
SubscriptionToken:      g93af799-6ae8-e111-8406-0050568261dc
Cookie:                 .ASPXAUTH=0186587E1743637D35632A7EDAF4F07EA67C6E4577770C3778FD9C17904A9D85B01369A8198B23A9AF530DBE93A68687C219BE1876B16B 0DAEBBD2C3318CA6C99D9C53E5B9FE17B7CF9661C5CDDDB97B90D5D3AF550100227EC8D6E6858FAE986AF2302C337B8DFEC6099898C19AA335A81317AB2B382DE72586AA9DF830C715332215AEBFD5E2FBA45F2BB5A7CA9793; path=/; HttpOnly

Request-Body

{
"ForeignOrderId" : "Externe ForeignOrderId"
}

Response

Response HTTP-Header

Status Code:            204 No Content
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Bezahlstatus setzen

Es gibt 2 Möglichkeiten des Zahlungeingang einer Bestellung per VIA-Connect API zu übermitteln:

per PaidAmount
per PaidDate

Details zu Plattformen

Ebay

Ebay unterstützt keine Teilzahlungen. Wird vom Fremdsystem ein "PaidAmount" übergeben, so übermittelt VIA-Connect den Bezahlstatus zu Ebay.

Request

Request Methode

PUT http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/PaidAmount

XML
JSON

Request HTTP-Header

Request Body

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PaidAmount p1:type="Edm.Decimal" xmlns:p1="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices">1.99</PaidAmount>

Request HTTP-Header

Request-Body

{
"PaidAmount" : "1.99"
}

Request

Request Methode

PUT http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/PaidDate

XML
JSON

Request HTTP-Header

Request Body

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<PaidDate p1:type="Edm.DateTime" xmlns:p1="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices">2012-09-06T10:07:14</PaidDate>

Request HTTP-Header

Request-Body

{
"PaidDate" : "2012-09-06T10:07:14"
}

Bedenken Sie bitte, dass die Zeit in UTC gesendet werden muss.

Response

Response HTTP-Header

Status Code:            204 No Content
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Versandstatus setzen

Sie können auch einzelne Artikel als versendet markieren (Teillieferung).
Schauen Sie dazu in die Beispiele von SalesOrderItems

Details zu Plattformen

Ebay

Ebay unterstützt keine Teillieferungen. Wird vom Fremdsystem die gesamte Bestellung (SalesOrders) oder sind alle Artikel (SalesOrdersItems) als versendet markiert, so übermittelt VIA-Connect den Versandstatus zu Ebay.

Request

Request Methode

PUT http://sandboxapi.via.de/publicapi/v1/api.svc/SalesOrders(1L)/ShippingStatus

XML
JSON

Request-HTTP-Header

Request-Body

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<ShippingStatus p1:type="Edm.Int32" xmlns:p1="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices">2</ShippingStatus>

Request-HTTP-Header

Request-Body

{
"ShippingStatus" : "2"
}

Response

Response HTTP-Header

Status Code:            204 No Content
Cache-Control:          no-cache
DataServiceVersion:     1.0;
...

Tags:

Erstellt von Thomas Hoffmann am 2012/08/24 11:24

SalesOrders Beispiele

Bestellungen abrufen

Alle Bestelldaten abrufen

Alle neuen Bestellungen abrufen

ForeignOrderId

Alle geänderten Bestellungen abrufen

ForeignOrderId setzen

Request

Response

Bezahlstatus setzen

Details zu Plattformen

Request

Request

Response

Versandstatus setzen

Details zu Plattformen

Request

Response

Dokumentation