| Name | Requirement | Type | Description |
|---|---|---|---|
| externalId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Agent external Reference |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| date | date | false | DDT creation. Example date=2020-06-01 |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| postingDate | date | false | DDT creation. Example date=2020-06-01 |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "FOOBAR1"
},
{
"externalId": "ACME3"
},
{
"externalId": "0101"
},
{
"externalId": "9014"
},
]
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| date | date | true | agent update date, ex. date=2019-07-01 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
{ "success": true, "data": [ { "agent": { "externalId": "1234", "name": "HOMER", "email": "homer.simpson@sbsmobile.it" }, "customers": [ "ACMECORP" ] } ] }
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
{
"success": true,
"data": [
{
"id": 1,
"externalId": "CUSTOMERCODE",
"currRevenue": 0,
"currNac": 0,
"currBackdated": 0,
"prevRevenue": 0,
"prevNac": 0,
"prevBackdated": 0
}
]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| date | date | false | Revenue update date, ex. date=2022-09-01 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| 461 |
|
{
"success": true,
"data": [
{
"externalId": "FOOBAR",
"distributor": "ERP1",
"companyName": "ACME Corp",
"fiscalCode": "2354420721",
"taxIdNumber": "354420721",
"telephone": "123456",
"language": "ITA",
"isoCountry": "IT",
"taxCode": "22",
"payment": "BON30G2FM",
"address": {
"id": 33202,
"legalAddress": "VIA TAL DEI TALI, 2\n ",
"zipCode": "70043",
"city": "MONOPOLI",
"county": "BA",
"country": "Italia",
"addressType": "-"
},
"addresses": [
{
"id": 125806,
"legalAddress": "VIA TAL DEI TALI, 2\n ",
"zipCode": "70043",
"city": "MONOPOLI",
"county": "BA",
"country": "Italia",
"addressType": "MONOPOLI"
},
{
"id": 125807,
"legalAddress": "VIA TAL DEI TALI, 2\n ",
"zipCode": "70043",
"city": "MONOPOLI",
"county": "BA",
"country": "Italia",
"addressType": "PDV"
}
],
"salesPerson": "9171",
"pricePolicies": [
"STORE"
]
},
]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| date | date | false | Order update date, ex. date=2019-07-01 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| 461 |
|
{
"success": true,
"data": [
{
"distributor": "ERP1",
"pricePolicies": [
"STORE"
],
"id": 1824,
"companyName": "ACME Spa",
"taxIdNumber": "01888310032",
"fiscalCode": "01888310032",
"account": "102020118",
"address": {
"id": 8636,
"legalAddress": "Via Circonvallazione s/n ",
"zipCode": "28010",
"city": "Miasino",
"county": "NO",
"country": "Italia",
"addressType": "-"
},
"addresses": [
{
"id": 116113,
"legalAddress": "This is the address, 1",
"zipCode": "21010",
"city": "FERNO",
"county": "VA",
"country": "Italia",
"addressType": "MALPE1"
},
{
"id": 116114,
"legalAddress": "This is the address, 2",
"zipCode": "21010",
"city": "FERNO",
"county": "VA",
"country": "Italia",
"addressType": "PDV"
}
],
"telephone": "3432444",
"internet": null,
"language": "ITA",
"languageArt": "ITA",
"payment": "CASSA_MALP0G",
"iban": null,
"currency": "EUR",
"shipToAddress": "MALPE1",
"discountFormula": null,
"purchaseGroup": "GROUPRETAIL",
"chain": "GROUPRETAIL",
"grid": null,
"isActive": true,
"managesBackOrder": false,
"daysBackOrder": 0,
"accountManager": "HOMER_AM",
"customer": null,
"priceListWeb": "oldpricelist",
"countryManager": "HOMER_CM",
"salesManager": "HOMER_SM",
"salesPerson": "9010",
"areaManager": "--",
"taxCode": "22",
"disabled": false,
"externalId": "FOOBAR1",
"customerType": 1,
"isoCountry": "IT",
"created": "2018-08-07T14:30:16+02:00",
"updated": "2019-08-10T02:00:22+02:00"
}
]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalIds | string | true | Customer external References, separated by comma |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
{
"success": true,
"data": [
{
"customerExternalId": "FOOBAR",
"customerBillTo": "SD-FOOBAR",
"docType": "Invoice",
"docNr": "nr422244",
"docYear": 2020,
"docDate": "2020-01-12",
"filename": "FOOBAR_Invoice_nr422244_2020.xlsx",
"createdAt": "2020-02-04T09:21:25+01:00",
"uuid": "93bced1e-4753-11ea-948b-0242ac1b0006"
}
]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| date | date | false | Documents created from this date, ex. date=2020-02-01 |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 500 |
|
{
"success": true,
"data": [
{
"id": 6294,
"orderStatus": {
"id": 15,
"name": "pending_payment"
},
"trackings": [],
"currency": "EUR",
"orderDate": "2019-10-28T15:35:25+01:00",
"deliveryDate": "2019-10-28T15:35:25+01:00",
"ordNo": "32104",
"externalOrdNo": "32104",
"notes": "spedire il 4 novembre..\na\ngrazie Homer",
"shipToCode": "PDV",
"carrier": "DefaultCarrier",
"tracking": null,
"shipService": "Default",
"shippingCost": "18.84",
"additionalDiscount": 0,
"items": [
{
"id": 108250,
"udcType": "M",
"qtyOrd": 5,
"qtyDelivered": 0,
"qtyNotDelivered": 0,
"valUnit": 6.49,
"refOrdId": " ",
"refDDTId": " ",
"refInvoiceId": " ",
"product": {
"id": 10237,
"ean": "8018417237232",
"saleMultiples": 1,
"disabled": false,
"externalId": "TECRUSB1ASTD",
"name": "Mini caricabatterie da Auto USB 12/24V 1000 mAh standard charge con porta USB",
"brand": "SBS",
"catalogue": "SBS",
"collection": null,
"topSeller": "TOP150",
"lifeCycleCod": null,
"created": "2018-08-06T21:19:25+02:00",
"updated": "2019-06-13T21:09:35+02:00"
},
"uom": "",
"saleType": false,
"discount1": 10,
"discount2": 0,
"line": 1,
"notes": "",
"orders": [
null
],
"promoCode": null
}
],
"documents": [],
"customer": {
"distributor": "ERP1",
"pricePolicies": [
"STORE"
],
"id": 1824,
"companyName": "ACME Spa",
"taxIdNumber": "01888310032",
"fiscalCode": "01888310032",
"account": "102020118",
"address": {
"id": 8636,
"legalAddress": "Via Circonvallazione s/n ",
"zipCode": "28010",
"city": "Miasino",
"county": "NO",
"country": "Italia",
"addressType": "-"
},
"addresses": [
{
"id": 116113,
"legalAddress": "This is the address, 1",
"zipCode": "21010",
"city": "FERNO",
"county": "VA",
"country": "Italia",
"addressType": "MALPE1"
},
{
"id": 116114,
"legalAddress": "This is the address, 2",
"zipCode": "21010",
"city": "FERNO",
"county": "VA",
"country": "Italia",
"addressType": "PDV"
}
],
"telephone": "3432444",
"internet": null,
"language": "ITA",
"languageArt": "ITA",
"payment": "CASSA_MALP0G",
"iban": null,
"currency": "EUR",
"shipToAddress": "MALPE1",
"discountFormula": null,
"purchaseGroup": "GROUPRETAIL",
"chain": "GROUPRETAIL",
"grid": null,
"isActive": true,
"managesBackOrder": false,
"daysBackOrder": 0,
"accountManager": "HOMER_AM",
"customer": null,
"priceListWeb": "oldpricelist",
"countryManager": "HOMER_CM",
"salesManager": "HOMER_SM",
"salesPerson": "9010",
"areaManager": "--",
"taxCode": "22",
"disabled": false,
"externalId": "FOOBAR1",
"customerType": 1,
"isoCountry": "IT",
"created": "2018-08-07T14:30:16+02:00",
"updated": "2019-08-10T02:00:22+02:00"
},
"salesPerson": null,
"payment": "RIBA60GFM",
"created": "2019-10-28T15:35:27+01:00",
"updated": "2020-01-21T14:07:15+01:00"
}
]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| date | date | false | Order update date |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
{
"success": true,
"data": [
{
"orderId": "35456",
"orderStatusId": 5
},
{
"orderId": "35676",
"orderStatusId": 25
},
]
}
------------------------------------
1 pending (waiting erp to fetch ) (internal)
2 completed (erp downloaded it) (internal)
------------------------------------
5 processing
------------------------------------
10 preparing
15 pending_payment
------------------------------------
20 partial_shipping
25 shipped
------------------------------------
99 canceled
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
{
"success": true,
"data": [
{
"orderId": "35676",
"trackings": [
{
"carrier": "EXE",
"tracking": "600004774",
"documentNo": "20SSIT00905",
"documentDate": "2020-01-14T00:00:00+01:00"
}
]
}
]
}
EXE / EXE2 : GLS
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
{
"currency": "dollar",
"orderStatus": 1,
"orderDate": "2011-07-14T19:43:37+0100",
"deliveryDate": "2011-07-14T19:43:37+0100",
"ordNo": "15/27637",
"externalOrdNo": "MERCE PER PDV 03-VC3123123",
"notes": "test non spedire",
"shipToCode": "PDV",
"carrier": "DHL",
"shipService": "express",
"shippingCost": "",
"saleType": "sale",
"customer": "12318",
"salesPerson": "",
"payment": "",
"additionalDiscount": 0,
"angelia": 0,
"priority": 0,
"orderAssignedTo": "client",
"returnReason": "DIFETTOSI",
"items": [{
"product": "idtest1",
"udcType": "M",
"qtyOrd": 6,
"qtyDelivered": 3,
"qtyNotDelivered": 1,
"valUnit": 2.6,
"discount1": 5.23,
"discount2": 0,
"uom": "",
"line": 1,
"saleType": "1",
"notes": "",
"refOrdId": "",
"refDDTId": " ",
"refInvoiceId": " "
"promoCode": null,
"reservationCode": ""
}]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| currency | string | true | Currency | |
| orderStatus | integer | true | Status code | |
| orderDate | timestamp | true | Order entry date | |
| deliveryDate | timestamp | true | Date of receipt of desired goods | |
| ordNo | string | true | Order number of the B2B | |
| externalOrdNo | string | true | Order number indicated by the customer | |
| notes | string | true | Head notes of the order | |
| shipToCode | string | true | Code for sending the goods indicated by the customer | |
| carrier | string | true | Code of the selected courier | |
| shipService | string | true | Code of service chosen for transport | |
| shippingCost | string | true | Cost of transport if due | |
| rifLogin | string | true | Reference to the login of the person who confirmed the cart | |
| line | integer | true | Order line number | |
| saleType | string | true | SaleType | |
| items | array | true | Array of items | |
| customer | string | true | Customer External Id | |
| salesPerson | string | false | Leave blank to not retrieve agent data during order import | |
| payment | string | false | Leave blank to set up customer payment during order import | |
| additionalDiscount | int | false | Total discount on order |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
{
"success": true,
"data": [
{
"externalId": "FOOBAR",
"entryNo": "405411",
"sellToCustomerNo": "FOOBAR",
"salesPersonCode": "TS-9198",
"docType": "Invoice",
"documentNo": "20FVI00653",
"documentDate": "2020-01-15 00:00:00",
"paymentMethodCode": "RIBA",
"paymentTermsCode": "30GFM",
"amount": "204.79",
"description": "Fattura 20SIT001055",
"currencyCode": "EUR",
"rateNr": "1",
"dueDate": "2020-02-29T00:00:00+01:00",
"amountRes": "204.79",
"salesChannel1": "OPERATORE",
"fulFillDate": null
},
{
"externalId": "ACMECORP",
"entryNo": "394531",
"sellToCustomerNo": "ACMECORP",
"salesPersonCode": "TS-9197",
"docType": "Payment",
"documentNo": "TEC04494",
"documentDate": "2020-01-07 00:00:00",
"paymentMethodCode": "",
"paymentTermsCode": "",
"amount": "0.00",
"description": "Fattura 20SIT001055",
"currencyCode": "EUR",
"rateNr": "1",
"dueDate": "2020-01-31T00:00:00+01:00",
"amountRes": "0",
"salesChannel1": "TELECOM SPECIALIST",
"fulFillDate": 2020-01-31T00:00:00+01:00 <-- when resolved this field is populated
},
]
}
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
date = YYYY-MM-DD (optional)
{
"success": true,
"data": [
{
"code": "CASSA_TORO0G",
"description": "Cassa negozio Torino ",
"createdAt": "2022-03-30T12:45:48+02:00",
"updatedAt": "2022-03-30T12:47:01+02:00"
},
{
"code": "BON45G",
"description": "Bonifico 45 gg data fattura",
"createdAt": "2022-03-30T12:45:48+02:00",
"updatedAt": "2022-03-30T12:47:01+02:00"
}
]
}
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
{
"success": true,
"data": [
{
"externalId": "STORE",
"currency": "EUR",
"policyType": "LINEARE",
"validFrom": "2019-02-14T00:00:00+01:00",
"validtill": "2022-01-31T00:00:00+01:00"
},
{
"externalId": "ACME_P",
"currency": "EUR",
"policyType": "LINEARE",
"validFrom": "2015-07-07T00:00:00+02:00",
"validtill": "2020-12-31T00:00:00+01:00"
}
]
}
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
[
{
"id": 14659,
"ean": "8018417263385",
"saleMultiples": 1,
"disabled": false,
"externalId": "TEBOOKLUXEIP58K",
"name": "Book case luxe per iPhone XS/X, nero",
"brand": "0",
"catalogue": "",
"collection": "",
"topSeller": "TOP400",
"lifeCycleCod": 99,
"created": "2018-11-08T11:03:49+01:00",
"updated": "2019-06-13T21:08:39+02:00"
}
]
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalIds | string | true | External Ids. Use , to concatenate more than one. Ex externalIds=TEBOOKLUXEIP58K |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| 469 |
|
| 461 |
|
Payload
[
"TEBOOKLUXEIP58K",
"PUMCHUSBAC20WWHI",
"PUMILAW40CHMP"
]
Response [ { "id": 14659, "ean": "8018417263385", "saleMultiples": 1, "disabled": false, "externalId": "TEBOOKLUXEIP58K", "name": "Book case luxe per iPhone XS/X, nero", "brand": "SBS", "catalogue": "", "collection": "", "topSeller": "", "lifeCycleCod": "00", "productType": "A", "contributionCategory": "SMARTPHONE", "created": "2018-11-08T11:03:49+01:00", "updated": "2024-07-23T15:46:30+02:00" } ]
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| array | array | true | List of skus TEBOOKLUXEIP58K,etc... |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| 469 |
|
| 461 |
|
[
"TEADAPTIPJACK35W",
"TESCREEN4DIP61K",
"TESCREEN4DIP65K",
"TESCREEN4DIPXAPK",
"TESCREEN4DIPXK",
"TESCREEN4DPZIPXK",
"TESCREENEASYFGSAS9K",
"TESCREENFCIPXK",
"TESCREENGLASSIP61",
"TESCREENGLASSIP65",
"TESCREENGLASSIPX",
"TESCREENSAS8P",
"TTBB100002UWL",
"TENANOIP61K",
"TENANOIP65K",
"TENANOIPXK"
]
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| updatedDate | datetime | true | Date, ex. updatedDate=2019-09-12 |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
{
"id": 14659,
"ean": "8018417263385",
"saleMultiples": 1,
"disabled": false,
"externalId": "TEBOOKLUXEIP58K",
"name": "Book case luxe per iPhone XS/X, nero",
"brand": "0",
"catalogue": "",
"collection": "",
"topSeller": "TOP400",
"lifeCycleCod": null,
"created": "2018-11-08T11:03:49+01:00",
"updated": "2019-06-13T21:08:39+02:00"
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | integer | true | External Id, ex. externalId=TEBOOKLUXEIP58K |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| 469 |
|
| 461 |
|
{
"success": true,
"data": {
"distributor": "ERP1",
"pricePolicies": [
"STORE"
],
"id": 1824,
"companyName": "ACME Spa",
"taxIdNumber": "01888310032",
"fiscalCode": "01888310032",
"account": "102020118",
"address": {
"id": 8636,
"legalAddress": "Via Circonvallazione s/n ",
"zipCode": "28010",
"city": "Miasino",
"county": "NO",
"country": "Italia",
"addressType": "-"
},
"addresses": [
{
"id": 116113,
"legalAddress": "This is the address, 1",
"zipCode": "21010",
"city": "FERNO",
"county": "VA",
"country": "Italia",
"addressType": "MALPE1"
},
{
"id": 116114,
"legalAddress": "This is the address, 2",
"zipCode": "21010",
"city": "FERNO",
"county": "VA",
"country": "Italia",
"addressType": "PDV"
}
],
"telephone": "3432444",
"internet": null,
"language": "ITA",
"languageArt": "ITA",
"payment": "CASSA_MALP0G",
"iban": null,
"currency": "EUR",
"shipToAddress": "MALPE1",
"discountFormula": null,
"purchaseGroup": "GROUPRETAIL",
"chain": "GROUPRETAIL",
"grid": null,
"isActive": true,
"managesBackOrder": false,
"daysBackOrder": 0,
"accountManager": "HOMER_AM",
"customer": null,
"priceListWeb": "oldpricelist",
"countryManager": "HOMER_CM",
"salesManager": "HOMER_SM",
"salesPerson": "9010",
"areaManager": "--",
"taxCode": "22",
"disabled": false,
"externalId": "FOOBAR1",
"customerType": 1,
"isoCountry": "IT",
"created": "2018-08-07T14:30:16+02:00",
"updated": "2019-08-10T02:00:22+02:00"
}
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| externalId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Customer external Reference |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
{
"success": true,
"data": {
"TEFB360SAS9": {
"MAGO-ITALIA": "1852",
"SBSDEUTSCHLAND": "13",
"SBSSCHWEIZ": "30"
},
"TECOOLIPSEB": {
"SBSDEUTSCHLAND": "31",
"SBSSCHWEIZ": "15"
}
}
}
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
{
"success": true,
"data": {
"externalId": "STORE",
"description": "LISTINO STORE",
"currency": "EUR",
"priority": 0,
"policy_type": "LINEARE",
"validFrom": "2017-12-18T00:00:00+01:00",
"validtill": "2020-12-31T00:00:00+01:00",
"prices": [
{
"sku": "SKU1",
"price": "10.24",
"retailPriceWithVat": "24.99"
},
{
"sku": "SKU2",
"price": "4.09",
"retailPriceWithVat": "9.99"
},
]
}
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| pricePolicyId |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
[
{
"domain": "www.sbsmobile.com",
"orderId": "14",
"distributor": "MAGO-ITALIA",
"currency": "EUR",
"rateVal": "22.000",
"paymentMethod": "fastbay1",
"paymentDescription": "eBay PayPal 104",
"transactionId" : "alphanumeric123",
"cartRuleCode": null,
"discount": 0,
"shippingCost": 4.9,
"amountPayed": 6.89,
"trackingNumber": "",
"orderDate": "2019-03-25 10:53:08",
"invoiceRequired": 1,
"sellTo": "EsselungaB2C",
"invoicingAddress": {
"id": "24",
"referenceName": "Alessandro Danesin",
"address": "via della vittoria, 155",
"zipCode": "30035",
"city": "Mirano",
"county": "Venezia",
"countyIso": "VE",
"country": "Italia",
"countryIso": "IT"
},
"shippingAddress": {
"id": "24",
"referenceName": "Alessandro Danesin",
"address": "via della vittoria, 155",
"zipCode": "30035",
"city": "Mirano",
"county": "Venezia",
"countyIso": "VE",
"country": "Italia",
"countryIso": "IT"
},
"customer": {
"id": "23",
"marketplaceCode": "PS",
"langIsoCode": "it",
"firstName": "Alessandro",
"lastName": "Danesin",
"companyName": null,
"birthDate": "0000-00-00",
"vatNumber": "01888310032",
"fiscalCode": null,
"sdi": null,
"pec": null,
"email": "pfmtnapxsgbq@fastbay.dummy",
"telephone": "041432042",
"gender": null
},
"items": [
{
"sku": "TEBB3000SELW",
"quantity": "1",
"valUnit": 1.99,
"discount": 0,
"reservationCode": "RISERB2C"
}
]
}
]
{
"success": true,
"data": {
"processed": [
{
"orderId": "14",
"id": 1
}
],
"notProcessed": []
}
{
"success": true,
"data": {
"processed": [],
"notProcessed": [
{
"orderId": "14",
"reason": "One or more order's item(s) are unknown."
}
]
}
}
{
"success": false,
"message": "Generic Error Occurred"
}
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| startDate | date | false | Return tracking created from this date on |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| orderNumber | string | false | Order Number (ordNo) | |
| orderStatus | string | false | Order status name | |
| customer | integer | false | Customer id | |
| startOrderDate | date | false | Order date FROM | |
| endOrderDate | date | false | Order date TO |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
{
"externalId": "DARTY",
"type": "AG",
"name": "test",
"email": "bar@foo.com",
"active": 1,
"areaManager": "DARY2",
"originalCreateDate": "2011-07-14T19:43:37+0100",
"originalUpdateDate": "2011-07-14T19:43:37+0100"
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Customer external Reference | |
| name | string | true | Customer name - Company name | |
| type | string | false | customer type | |
| string | false | emails | ||
| active | boolean | false | is agent active | |
| areaManager | string | false | agent ExternalId | |
| originalCreateDate | date | true | agent ExternalId | |
| originalUpdateDate | date | true | agent ExternalId |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Customer external Reference | |
| name | string | false | Customer name - Company name | |
| type | string | false | customer type | |
| string | false | emails | ||
| active | boolean | false | is agent active | |
| areaManager | string | false | agent ExternalId | |
| originalCreateDate | date | true | agent ExternalId | |
| originalUpdateDate | date | true | agent ExternalId |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 401 |
|
| 400 |
|
{
"externalId": "DARTY",
"companyName": "KESA SOURCING Limited - Filiale Italiana",
"taxIdNumber": "04570750960",
"fiscalCode": "04570750960",
"account": "01011000",
"zip_code": "20037",
"legalAddress": "S.S. 35 DEI GIOVI",
"city": "PADERNO DUGNANO",
"county": "MI",
"country": "ITALIA",
"addressType": "test1",
"telephone": "02/96753068",
"internet": "",
"language": "IT",
"languageArt": "DARTY",
"payment": "BB60",
"iban": "",
"currency": "EUR",
"shipToAddress": "DARTYD",
"discountFormula": "",
"purchaseGroup": "KESA",
"chain": "DARTY",
"grid": "",
"isActive": false,
"managesBackOrder": false,
"b2bEnabled": true,
"clusterB2B": "",
"daysBackOrder": 0,
"accountManager": "FRANCESCHINA",
"customer": "",
"priceListWeb": "",
"countryManager": "",
"salesManager": "",
"salesPerson": "9010",
"areaManager": "9908",
"taxCode": "04570750960",
"disabled": 0,
"customerType": 1,
"isoCountry": "IT",
"profileType": "ACCESSORI",
"crossReferenceGroupCode": "Grp_Code",
"addresses": [{
"zip_code": "20010",
"legalAddress": "STRADA PROVINCIALE 34/A ",
"city": "OSSONA",
"county": "MI",
"country": "ITALIA",
"addressType": "test54"
},
{
"zip_code": "26865",
"legalAddress": "VIA EMILIA 100 ",
"city": "S.ROCCO AL PORTO",
"county": "LO",
"country": "ITALIA",
"addressType": "test21"
},
{
"zip_code": "20010",
"legalAddress": "STRADA PROVINCIALE 34/A ",
"city": "OSSONA",
"county": "MI",
"country": "",
"addressType": "test123"
}]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| companyName | string | true | Customer name - Company name | |
| taxIdNumber | string | false | VAT number | |
| fiscalCode | string | false | Fiscal code | |
| account | string | true | This is the identification number of the area type | |
| zip_code | string | true | Legal ZIP code | |
| legalAddress | string | true | Registered office addrees | |
| city | string | true | Registered office city | |
| county | string | true | Registered office county | |
| country | string | true | Registered office country | |
| addressType | string | true | addressType | |
| telephone | string | false | Main telephone | |
| internet | string | false | Website | |
| language | string | false | Client language code | |
| languageArt | string | false | Customer's item language code | |
| payment | string | true | Payment type code | |
| iban | string | false | IBAN | |
| currency | string | false | Customer base currency | |
| shipToAddress | string | false | Seat code of goods sent to the customer (preferential) | |
| discountFormula | string | false | Typical customer discount formula | |
| purchaseGroup | string | false | A customer's highest level of affiliation | |
| clusterB2B | string | false | ERP / CRM Cluster classification | |
| chain | string | false | Second highest level of affiliation of a customer | |
| grid | string | false | Representative code of the exhibition of products dedicated to the customer | |
| isActive | boolean | true | True if the customer is active | |
| managesBackOrder | boolean | true | True if the customer manages the back order | |
| b2bEnabled | boolean | true | True if the customer once in B2B should be granted to work within the platform | |
| daysBackOrder | integer | true | Number of days of duration of a back order before being eventually canceled | |
| accountManager | string | false | Commercial figure following the customer | |
| customer | integer | false | It is the valid customer code | |
| priceListWeb | string | false | Dedicated price list code for the web channel | |
| countryManager | string | false | Reference commercial figure on the nation territory | |
| salesManager | string | false | Commercial figure of sales reference | |
| salesPerson | string | false | Reference agency code on the territory | |
| areaManager | string | false | Sales reference sales figure | |
| taxCode | string | true | Reference VAT code | |
| disabled | boolean | false | Disabled | |
| addresses | array | false | List of secondary addresses | |
| externalId | string | true | Customer external Reference | |
| customerType | integer | true | 1 for natural person and 2 for legal person | |
| isoCountry | string | true | The standard 2 characters iso country code | |
| profileType | string | true | ACCESSORI || SERVIZI |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Customer external Reference | |
| companyName | string | false | Customer name - Company name | |
| taxIdNumber | string | false | VAT number | |
| fiscalCode | string | false | Fiscal code | |
| account | string | false | This is the identification number of the area type | |
| zip_code | string | false | Legal ZIP code | |
| legalAddress | string | false | Registered office addrees | |
| city | string | false | Registered office city | |
| county | string | false | Registered office county | |
| country | string | false | Registered office country | |
| addressType | string | false | addressType | |
| telephone | string | false | Main telephone | |
| internet | string | false | Website | |
| language | string | false | Client language code | |
| languageArt | string | false | Customer's item language code | |
| payment | string | false | Payment type code | |
| iban | string | false | IBAN | |
| currency | string | false | Customer base currency | |
| shipToAddress | string | false | Seat code of goods sent to the customer (preferential) | |
| discountFormula | string | false | Typical customer discount formula | |
| purchaseGroup | string | false | A customer's highest level of affiliation | |
| chain | string | false | Second highest level of affiliation of a customer | |
| grid | string | false | Representative code of the exhibition of products dedicated to the customer | |
| isActive | boolean | false | True if the customer is active | |
| managesBackOrder | boolean | false | True if the customer manages the back order | |
| daysBackOrder | integer | false | Number of days of duration of a back order before being eventually canceled | |
| accountManager | string | false | Commercial figure following the customer | |
| customer | integer | false | It is the valid customer code | |
| priceListWeb | string | false | Dedicated price list code for the web channel | |
| countryManager | string | false | Reference commercial figure on the nation territory | |
| salesManager | string | false | Commercial figure of sales reference | |
| salesPerson | string | false | Reference agency code on the territory | |
| areaManager | string | false | Sales reference sales figure | |
| taxCode | string | false | Reference VAT code | |
| disabled | boolean | false | Disabled | |
| addresses | array | false | List of secondary addresses | |
| customerType | integer | false | 1 for natural person and 2 for legal person | |
| isoCountry | string | false | The standard 2 characters iso country code |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "SBSTEST",
"companyName": "SBS Spa",
"taxIdNumber": "01888310032",
"fiscalCode": "01888310032",
"zip_code": "28010",
"legalAddress": "Via Circonvallazione s\/n ",
"county": "NO",
"country": "Italia",
"addressType": "-",
"city": "Miasino",
"telephone": "0322-980909",
"language": "ITA",
"languageArt": "ITA",
"payment": "BON0G",
"account": "102020101",
"taxCode": "22",
"currency": "EUR",
"discountFormula": "0",
"isActive": 1,
"managesBackOrder": 0,
"B2Benabled": 0,
"salesPerson": "9010",
"areaManager": "",
"customerType": 1,
"disabled": 0,
"isoCountry": "IT",
"salesManager": "DIREZIONALE_SM",
"countryManager": "MGRANDI_CM",
"purchaseGroup": "CORPORATE",
"chain": "AZIENDE",
"accountManager": "DIREZIONALE_AM",
"angeliaForYouByYou": "1",
"angeliaCluster": "Test",
"crossReferenceGroupCode": "Grp_Code",
"addresses": [
{
"addressType": "PDV",
"legalAddress": "Via Circonvallazion s\/n",
"zip_code": "28010",
"city": "MIASINO",
"country": "Italia",
"county": "NO"
},
{
"addressType": "TEST",
"legalAddress": "Via Circonvallazion s\/n",
"zip_code": "28010",
"city": "MIASINO",
"country": "Italia",
"county": "NO"
}
]
}
]
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Customer external Reference | |
| companyName | string | false | Customer name - Company name | |
| taxIdNumber | string | false | VAT number | |
| fiscalCode | string | false | Fiscal code | |
| account | string | false | This is the identification number of the area type | |
| zip_code | string | false | Legal ZIP code | |
| legalAddress | string | false | Registered office addrees | |
| city | string | false | Registered office city | |
| county | string | false | Registered office county | |
| country | string | false | Registered office country | |
| addressType | string | false | addressType | |
| telephone | string | false | Main telephone | |
| internet | string | false | Website | |
| language | string | false | Client language code | |
| languageArt | string | false | Customer's item language code | |
| payment | string | false | Payment type code | |
| iban | string | false | IBAN | |
| currency | string | false | Customer base currency | |
| shipToAddress | string | false | Seat code of goods sent to the customer (preferential) | |
| discountFormula | string | false | Typical customer discount formula | |
| purchaseGroup | string | false | A customer's highest level of affiliation | |
| chain | string | false | Second highest level of affiliation of a customer | |
| grid | string | false | Representative code of the exhibition of products dedicated to the customer | |
| isActive | boolean | false | True if the customer is active | |
| managesBackOrder | boolean | false | True if the customer manages the back order | |
| B2Benabled | boolean | false | True if the customer can use all the features on B2B | |
| daysBackOrder | integer | false | Number of days of duration of a back order before being eventually canceled | |
| accountManager | string | false | Commercial figure following the customer | |
| customer | integer | false | It is the valid customer code | |
| priceListWeb | string | false | Dedicated price list code for the web channel | |
| countryManager | string | false | Reference commercial figure on the nation territory | |
| salesManager | string | false | Commercial figure of sales reference | |
| salesPerson | string | false | Reference agency code on the territory | |
| areaManager | string | false | Sales reference sales figure | |
| taxCode | string | false | Reference VAT code | |
| disabled | boolean | false | Disabled | |
| addresses | array | false | List of secondary addresses | |
| customerType | integer | false | 1 for natural person and 2 for legal person | |
| isoCountry | string | false | The standard 2 characters iso country code | |
| angeliaForYouByYou | string | false | 0 = off; 1 = for you; 2 = by you | |
| angeliaCluster | string | false | Which cluster should be used |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "9993",
"name": "Davide Bresciani",
"email": "davide.bresciani@sbsmobile.it"
},
{
"externalId": "9996",
"name": "Valentina Rasoli",
"email": "valentina.rasoli@sbsmobile.it"
}
]
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
{
"items: [
{
"qtyNotDelivered":10,
"product":"TESCREENLGL90A2"
}
]
}
This is a void endpoint
| Name | Requirement | Type | Description |
|---|---|---|---|
| orderNo |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
[
{
"orderId" : 1234,
"trackings" : [
{
"documentNo" : "XYA-002775/A18_2",
"documentDate" : "2019-11-01",
"carrier" : "EXE",
"tracking": "5959272872"
},
{
"documentNo" : "18123-DSFDS/A11_2",
"documentDate" : "2019-11-02",
"carrier" : "EXE",
"tracking": "8181762363"
}
]
},
{
"orderId" : 9876,
"trackings" : [
{
"documentNo" : "XYA-002775/A19_2",
"documentDate" : "2019-11-01",
"carrier" : "EXE",
"tracking": "5959272872"
}
]
}
]
{
"updated" : [ 1234 ],
"notUpdated" => [
{
9876: "message about the error occured"
}
]
}
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
5 = pending_payment
10 = processing
15 = preparing
20 = partial_shipping
25 = shipped
[
{
"orderId" : 1234,
"orderStatus" : 3,
},
{
"orderId" : 9876,
"orderStatus" : 5,
}
]
{
"updated" : [ 1234 ],
"notUpdated" => [
{
9876: "message about the error occured"
}
]
}
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| orderStatus | string | false | Order status name | |
| customer | integer | false | Customer id | |
| startOrderDate | date | false | Order date FROM | |
| endOrderDate | date | false | Order date TO | |
| startDeliveryDate | date | false | Delivery date FROM | |
| endDeliveryDate | date | false | Delivery date TO | |
| orderTemplate | string | false | which kind of order should we need ? can be 'default' or 'picea' |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
Receives a file to be forwarded to B2B
{id} = Charlie's ID (not "ordNo" or "externalOrdNo")
nrDoc: doc15813-19
docType: Invoice
| Name | Requirement | Type | Description |
|---|---|---|---|
| id |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| file | file | true | Invoice file | |
| docType | string | true | Document type | |
| nrDoc | string | true | Document number |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
{
"success": true,
"data": {
"id": 1668,
"orderStatus": {
"id": 2,
"name": "completed"
},
"currency": "EUR",
"orderDate": "2019-04-01T10:59:45+02:00",
"deliveryDate": "2019-04-01T10:59:44+02:00",
"ordNo": "9349",
"externalOrdNo": "9349",
"notes": "applica promo b\ngrazie",
"shipToCode": "PISA",
"carrier": "DefaultCarrier",
"shipService": "Default",
"shippingCost": "4.05",
"additionalDiscount": 0,
"assignTo": "client",
"items": [
{
"id": 29987,
"udcType": "M",
"qtyOrd": 1,
"qtyDelivered": 0,
"qtyNotDelivered": 0,
"valUnit": 11.14,
"refOrdId": " ",
"refDDTId": " ",
"refInvoiceId": " ",
"product": {
"id": 11218,
"ean": "8018417219023",
"disabled": false,
"externalId": "TESCREEN3DSAS7K",
"name": "Screen Protector 3D full screen per Samsung GalaxyS7 colore nero",
"brand": "SBS",
"catalogue": "SBS",
"collection": null,
"topSeller": null,
"created": "2018-08-06T21:41:43+02:00",
"updated": "2019-04-15T20:11:39+02:00"
},
"uom": "",
"saleType": false,
"discount1": 0,
"discount2": 0,
"line": 1,
"notes": "",
"orders": [
null
],
"promoCode": null,
"reservationCode": "RISERB2B"
},
{
"id": 29988,
"udcType": "M",
"qtyOrd": 1,
"qtyDelivered": 0,
"qtyNotDelivered": 0,
"valUnit": 5.84,
"refOrdId": " ",
"refDDTId": " ",
"refInvoiceId": " ",
"product": {
"id": 14287,
"ean": "8018417259609",
"disabled": false,
"externalId": "TESKINHUMA20T",
"name": "Cover skinny per Huawei Mate 20, colore trasparente",
"brand": "0",
"catalogue": "SBS",
"collection": "SKINNY",
"topSeller": null,
"created": "2018-09-21T15:52:11+02:00",
"updated": "2019-03-29T21:54:00+01:00"
},
"uom": "",
"saleType": false,
"discount1": 0,
"discount2": 0,
"line": 1,
"notes": "",
"orders": [
null
],
"promoCode": null,
"reservationCode": null
},
],
"documents": [],
"customer": {
"distributor": "MAGO-ITALIA",
"pricePolicies": [
"TS_PROMO_B",
"TELSPEC"
],
"id": 965,
"companyName": "C.S.T SAS",
"taxIdNumber": "01052380506",
"fiscalCode": "01052380506",
"account": "102020101",
"address": {
"id": 3332,
"legalAddress": "VIA DI PRATALE 8/A ",
"zipCode": "56127",
"city": "PISA",
"county": "PI",
"country": "Italia",
"addressType": "-"
},
"addresses": [
{
"id": 93744,
"legalAddress": "VIA DI PRATALE 8/A",
"zipCode": "56127",
"city": "PISA",
"county": "PI",
"country": "Italia",
"addressType": "PDV"
},
{
"id": 93745,
"legalAddress": "VIA DI PRATALE 8/A",
"zipCode": "56127",
"city": "PISA",
"county": "PI",
"country": "Italia",
"addressType": "PISA"
}
],
"telephone": "050/561818",
"internet": null,
"language": "ITA",
"languageArt": "ITA",
"payment": "BON60GFM",
"iban": null,
"currency": "EUR",
"shipToAddress": "PISA",
"discountFormula": "10",
"purchaseGroup": "FASTWEB",
"chain": "TELECOMSPECIALIST",
"grid": null,
"isActive": true,
"managesBackOrder": false,
"daysBackOrder": 0,
"accountManager": "BERTERAME_AM",
"customer": null,
"priceListWeb": "W10TS",
"countryManager": "IADELUCA_CM",
"salesManager": "CUTRERA_SM",
"salesPerson": "9197",
"areaManager": "9950",
"taxCode": "CITA",
"disabled": false,
"externalId": "CST",
"customerType": 1,
"isoCountry": "IT",
"created": "2018-08-07T14:17:28+02:00",
"updated": "2019-05-20T21:00:30+02:00"
},
"salesPerson": null,
"payment": "BB60",
"created": "2019-04-01T10:59:47+02:00",
"updated": "2019-04-04T19:37:48+02:00"
}
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| orderId |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
{
"orderStatus":1
}
### Example JSON Order Update - DEPRECATED ### { "orderStatus":1, "currency":"dollar", "deliveryDate":"2011-07-14T19:43:37+01:00", "ordNo":"15/27637", "externalOrdNo":"MERCE PER PDV 03-VC3123123", "notes":"test non spedire", "shipToCode":"PDV", "carrier":"DHL", "shipService":"express", "items":[ { "udcType":"M", "qtyOrd":13, "qtyDelivered":3, "qtyNotDelivered":10, "valUnit":2.6, "refOrdId":"", "refDDTId":" ", "refInvoiceId":" ", "product":"TESCREENLGL90A2", "uom":"", "saleType":true, "discount1":5.23, "discount2":0, "line":1, "notes":"" } ] }
| Name | Requirement | Type | Description |
|---|---|---|---|
| orderId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| currency | string | false | Currency | |
| orderStatus | integer | false | Status code | |
| orderDate | timestamp | false | Order entry date | |
| deliveryDate | timestamp | false | Date of receipt of desired goods | |
| ordNo | string | false | Order number of the B2B | |
| externalOrdNo | string | false | Order number indicated by the customer | |
| notes | string | false | Head notes of the order | |
| shipToCode | string | false | Code for sending the goods indicated by the customer | |
| carrier | string | false | Code of the selected courier | |
| shipService | string | false | Code of service chosen for transport | |
| shippingCost | string | false | Cost of transport if due | |
| rifLogin | string | false | Reference to the login of the person who confirmed the cart | |
| line | integer | false | Order line number | |
| saleType | string | false | SaleType | |
| items | array | false | Array of items | |
| customer | string | false | Customer External Id | |
| salesPerson | string | false | Leave blank to not retrieve agent data during order import | |
| payment | string | false | Leave blank to set up customer payment during order import | |
| additionalDiscount | int | false | Total discount on order |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
1^ format - single ack
{ "customerId": 6451, "domain": "www.sbsmobile.com" }
2^ format - multi ack [ { "customerId": 6451, "domain": "www.sbsmobile.com" }, { "customerId": 451, "domain": "www.foobar.com" } ]
{
"success": true,
"data": {
"acked": [
{ "customerId": 6451, "domain": "www.sbsmobile.com" }
],
"notAcked": [
{ "customerId": 451, "domain": "www.foobar.com" }
]
}
}
{
"success": false,
"message": "Generic Error Occurred"
}
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
{
"success": true,
"data": [
{
"shippingAddress": {
"externalId": 4,
"address": "via della vittoria, 155",
"zipCode": "30035",
"city": "Mirano",
"county": "Venezia",
"countyIso": "VE",
"country": "Italia",
"countryIso": "IT"
},
"invoicingAddress": {
"externalId": 2,
"address": "Foo Bar address, 12",
"zipCode": "30035",
"city": "Mirano",
"county": "Venezia",
"countyIso": "VE",
"country": "Italia",
"countryIso": "IT"
},
"externalId": "23",
"marketplaceCode": "PS",
"erpId": null,
"langIsoCode": "it",
"firstName": "Foo",
"lastName": "Bar",
"companyName": null,
"birthDate": "1970-01-01T00:00:00+00:00",
"vatNumber": "01888310032",
"fiscalCode": null,
"sdi": null,
"pec": null,
"telephone": "041432042",
"email": "foo@bar.it",
"gender": null
},
{
"shippingAddress": {
"externalId": 5,
"address": "piazza san babila 155",
"zipCode": "30035",
"city": "Mirano",
"county": "Venezia",
"countyIso": "VE",
"country": "Italia",
"countryIso": "IT"
},
"invoicingAddress": {
"externalId": 5,
"address": "piazza san babila 155",
"zipCode": "30035",
"city": "Mirano",
"county": "Venezia",
"countyIso": "VE",
"country": "Italia",
"countryIso": "IT"
},
"externalId": "3",
"marketplaceCode": "EB",
"erpId": null,
"langIsoCode": "it",
"firstName": "Alessandro",
"lastName": "Danesin",
"companyName": null,
"birthDate": "1970-01-01T00:00:00+00:00",
"vatNumber": "01888310032",
"fiscalCode": null,
"sdi": null,
"pec": null,
"telephone": "041432042",
"email": "pfmtnapxsgbq@fastbay.dummy",
"gender": "F",
"invoiceRequired": false,
"sellTo": "EsselungaB2C"
}
]
}
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| all | string | false | Default null, customers with unacked orders; Set to 1 to the the whole list |
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
1^ format - single order
{"orderId":"909011","domain":"www.sbsmobile.com"}
2^ format - multi orders
[
{"orderId":"909011","domain":"www.sbsmobile.com"},
{"orderId":"132","domain":"www.caseandme.com"}
]
{
"success": true,
"data": {
"acked": [
{"orderId":"909011","domain":"www.sbsmobile.com"}
],
"notAcked": [
{"orderId":"132","domain":"www.caseandme.com"}
]
}
}
{
"success": false,
"message": "Generic Error Occurred"
}
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
{
"success": true,
"data": [
{
"shippingAddress": {
"externalId": 1,
"address": "via circonvallazione",
"zipCode": "28028",
"city": "Pettenasco",
"county": "Novara",
"countyIso": "NO",
"country": "Italia"
"countryIso": "IT"
},
"invoicingAddress": {
"externalId": 1,
"address": "via circonvallazione",
"zipCode": "28028",
"city": "Pettenasco",
"county": "Novara",
"countyIso": "NO",
"country": "Italia"
"countryIso": "IT"
},
"orderlId": 1,
"orderDate": "2019-05-08T10:36:00+00:00",
"distributor": "MAGO-ITALIA",
"currency": "EUR",
"rateVal": 22,
"paymentMethod": "Modulo di pagamento Stripe",
"cartRuleCode": "CONNECT25",
"discount": 9.95,
"shippingCost": null,
"amountPayed": 129.64,
"trackingNumber": "vb590032319",
"trackingUrl": null,
"items": [
{
"sku": "TASCREENIPAD6A",
"quantity": 1,
"valUnit": 19.9,
"discount": null
},
{
"sku": "BAR",
"quantity": 1,
"valUnit": 19.9,
"discount": null,
"reservationCode": "RISERB2C"
},
{
"sku": "AAAAA",
"quantity": 1,
"valUnit": 149.79,
"discount": 50
}
],
"customerId": 23,
"invoiceRequired": 1,
"sellTo": "EsselungaB2C"
}
]
}
These are the latest address seen at order time.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| all | string | false | Default null: unacked orders; Set to 1 to the the whole list |
| Status Code | Description |
|---|---|
| 200 |
|
| 500 |
|
[ {
"externalId": "CUSTOMER_CODE",
"groupCode": "CUSTOMER_GROUP_CODE",
"items": {
"TESKINHUY7T": 891173,
"TEFEELIP6R": 887464
}
} ]
or
{
"groupCode": "CUSTOMER_GROUP_CODE",
"items": {
"TESKINHUY7T": 891173,
"TEFEELIP6R": 887464
}
}
or
{
"externalId": "CUSTOMER_CODE",
"items": {
"TESKINHUY7T": 891173,
"TEFEELIP6R": 887464
}
}
{
"success": true,
"data": {
"msg": "Successfully imported"
}
}
in case of missing mandatory data
{
"success": true,
"data": {
"error": "No customer (externalId) or group given (groupCode)"
}
}
| Status Code | Description |
|---|---|
| 200 |
|
[
{
"hierarchyType": "P",
"externalId": "SD-MAXIDI",
"parentExternalId": "",
"crossReferenceGroupCode": "GAL",
"parentCrossReferenceGroupCode": ""
},
{
"hierarchyType": "F",
"externalId": "MAXIDIBRESCI",
"parentExternalId": "SD-MAXIDI",
"crossReferenceGroupCode": "",
"parentCrossReferenceGroupCode": "GAL"
},
{
"hierarchyType": "PS",
"externalId": "2LLAFENICESR",
"parentExternalId": "",
"crossReferenceGroupCode": "WIND",
"parentCrossReferenceGroupCode": ""
}
]
| Status Code | Description |
|---|---|
| 200 |
|
{
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| customer |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
Well-known document types :
| DocType |
|------------|
| Invoice |
| Shipment |
| CreditMemo |
NOTE : Can be used any undocument docType to create groups. No restriction is applied but correct propagation to consumer is not guaranteed.
File name as below seperated by _
| Customer | Customer Bill-to | DocType | DocNr | Year-Month-Day | Extension |
|----------+------------------+-------------+-------------+----------------+-----------|
| B2BCust | B2BCust | Invoice | IT-2928228 | 2020-01-12 | pdf |
| B2BCust2 | SD-B2BCust2 | Shipment | 19SSFR00449 | 2019-10-01 | pdf |
| B2BCust2 | SD-B2BCust2 | CreditMemo | IT-222 | 2020-07-07 | xlsx |
| B2BFoo | B2BFoo | OtherType | MyWordName | 2019-09-23 | doc |
Customer_CustomerBillTo_DocType_DocNr_Year-Month-Day.ext = B2BCUSTOMER_SD-B2BCUSTOMER_invoice_IT-123324FFA_2019-01-12.pdf
Upload a file to the cloud
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| file | file | true | File name as Customer_DocType_DocNr_Year.ext |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 500 |
|
[
{
"id": "3GPHONE",
"entries": [
{
"entryNo": 104259,
"customerNo": "FOOBAR",
"sellToCustomerNo": "FOOBAR",
"salespersonCode": "TS-9200",
"tipoDoc": "Invoice",
"documentNo": "19FVI10339",
"documentDate": "2019-05-17",
"paymentMethodCode": "RD",
"paymentTermsCode": "30G2FM",
"amount": "443.97",
"description": "Fattura 19SIT005223",
"currencyCode": "EUR",
"rateNr": 1,
"dueDate": "2019-06-30",
"amountRes": "443.97",
"salesChannel1": "OPERATORE"
},
{
"entryNo": 104260,
"customerNo": "FOOBAR",
"sellToCustomerNo": "FOOBAR",
"salespersonCode": "TS-9200",
"tipoDoc": "Invoice",
"documentNo": "19FVI10339",
"documentDate": "2019-05-17",
"paymentMethodCode": "RD",
"paymentTermsCode": "30G2FM",
"amount": "443.97",
"description": "Fattura 19SIT005223",
"currencyCode": "EUR",
"rateNr": 2,
"dueDate": "2019-07-31",
"amountRes": "443.97",
"salesChannel1": "OPERATORE"
}
]
}
]
{
"success": true,
"data": {
"processed": [
{
"customerNo": "FOOBAR",
"entryNo": "104259",
"reason": null
},
{
"customerNo": "FOOBAR",
"entryNo": "104260",
"reason": null
}
],
"unprocessed": []
}
}
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
[
{
"code": "CASSA_TORO0G",
"description": "Cassa negozio Torino "
},
{
"code": "BON45G",
"description": "Bonifico 45 gg data fattura"
},
]
{
"success": true,
"data": {
"success": true,
}
}
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
The keys of the definition are :
- description(string),
- currency(string, ISO 4217),
- priority (int, 0-99),
- policy_type(string),
- valid_from(date),
- valid_till(date)
and prices, a dictionary of prices where the key is the SKU and the value is comprised of the price (decimal(9,2)) and retail_price_with_vat(decimal(9,2)).
| Status Code | Description |
|---|---|
| 200 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
For example:
{
'TRILLOSRL': ['RETAIL'],
'TROVITUTTO': ['RETAIL','PROMO_TS2017','TS_PROMO_C']
}
| Status Code | Description |
|---|---|
| 200 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | integer | true | External Id | |
| disabled | boolean | false | Disabled | |
| ean | string | false | Product ean | |
| name | string | false | Product name | |
| brand | string | false | Product brand | |
| catalogue | string | false | Product catalogue | |
| collection | string | false | Product collection | |
| topSeller | string | false | Product topSeller |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| disabled | boolean | false | Disabled | |
| name | string | true | Product name | |
| externalId | string | true | Product external Reference | |
| ean | string | false | Product ean | |
| brand | string | false | Product brand | |
| catalogue | string | false | Product catalogue | |
| collection | string | false | Product collection | |
| topSeller | string | false | Product topSeller |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | integer | true | External Id | |
| disabled | boolean | false | Disabled | |
| ean | string | false | Product ean | |
| name | string | false | Product name | |
| brand | string | false | Product brand | |
| catalogue | string | false | Product catalogue | |
| collection | string | false | Product collection | |
| topSeller | string | false | Product topSeller |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "TEPOLOPROIP12K",
"firstOrderAt": "2020-06-23",
"nextOrderEta": "2021-02-28",
"nextOrderQty": 1008,
"latestOrderTa": "2021-01-04",
"latestOrderQty": 1512
}
]
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| Name | Requirement | Type | Description |
|---|---|---|---|
| externalId |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalId | string | true | Agent external Reference |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| externalIds | string | false | One or more ExternalId contatenated by comma |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "ALDORAINESRL",
"forYouByYou": 1,
"cluster": "",
"documentNo": "20SSIT12658",
"postingDate": "2020-05-28T00:00:00+02:00",
"lineNo": "770000",
"item": "TESKINSAS10CT",
"crossReferenceNo": "",
"quantity": 3,
"carrier" : "GLS",
"trackingCode" : "vb600077475"
}
]
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
[
{
"ddtNo": "23SSIT03309",
"orderId": 14921,
"domain": "www.sbsmobile.com",
"trackingCode": "",
"shippingAgentCode": "SBS" <<--- for this we should only set the PrestaShop order to shipped - No tracking due hand-hold delivery (employee)
},
{
"ddtNo": "23SSIT03461",
"orderId": 14925,
"domain": "www.sbsmobile.com",
"trackingCode": "1881436001",
"shippingAgentCode": "EXE2" <<--- EXE||EXE2 = GLS; DHL = DHL
}
]
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "$00000026584",
"billTo": "$00000026584",
"ownerUserId": 1,
"accountManager": "CARESANA_AM",
"countryManager": "MGRANDI_CM",
"salesManager": "CARESANA_SM",
"salesDirector": "MGRANDI_SD",
"salesPerson": "9010",
"salesPerson2": "",
"areaManager": "",
"b2bEnabled": "0",
"purchaseGroup": "SBS B2C",
"chain": "SBS B2C",
"chainBi": "SBS B2C",
"wind_channel": "FRANCHISING",
"activeBi": "0",
"lastDateModified": "2019-12-09T00:00:00+01:00"
}
]
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
[
{
"externalId": "TELERITZ",
"currRevenue": 0,
"currNac": 0,
"currBackdated": 0,
"prevRevenue": 0,
"prevNac": 0,
"prevBackdated": 0
}
]
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| customer | string | true | Customer externalId |
| Status Code | Description |
|---|---|
| 200 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 401 |
|
| 400 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| customer | string | true | Customer | |
| priority | int | false | Priority | |
| list | string | true | List | |
| product | string | true | Product | |
| startDate | datetime | true | Start date | |
| endDate | datetime | false | End date | |
| quantity | float | true | Quantity | |
| price | float | false | Price | |
| discount1 | float | false | Discount 1 | |
| discount2 | float | false | Discount 2 | |
| isPrezzoPvp | number | false | pvp price |
| Status Code | Description |
|---|---|
| 200 |
|
| 401 |
|
| 400 |
|
Documentation auto-generated on Mon, 26 Oct 26 17:59:16 +0100