Duomenų mainai

Softera.eCom sprendimas leidžia siųsti užsakymus, kurti pirkėjus, prekes, atnaujinti listingus naudojant API. Šiame skyriuje bus pateikti šių procesų bendriniai aprašymai, užklausų ir jais siunčiamos informacijos pavyzdžiai. Kiekvienos integracijos metu turi būti derinama kokia informacija bus siunčiama ir atskirai derinami „eCom nustatymai“, jog procesas vyktų pagal kliento turimą procesą.

Šiame skyriuje atrašytos yra tik užklausos, kuriomis informacija yra siunčiama į BC. Detalesni užklausų aprašymai ir pavyzdžiai yra pateikiami JSON formatu. Pagrindiniai informacijos paėmimo pavyzdžiai pateikti skyriuje „Eksportuojamų duomenų pavyzdžiai“.

PREKIŲ KŪRIMAS

Prieš prekių iš e-parduotuvės kūrimą, BC turi būti padaryti šie veiksmai:

• Reikiamoje „eCom parduotuvės kortelėje“ uždėti požymį „Kurti prekes“ (jei šis požymis bus neigiamas, per API bus gaunama klaida bandant kurti prekes;
• Reikiamoje „eCom parduotuvės kortelėje“ nurodyti „Numatytasis prekės šablono kodas“. Šis veiksmas reikalingas tokiu atveju, jei per API nebus paduodamas kūrimo šablono kodas.

Prekių kūrimui yra naudojama tarpinis sąrašas „eCom išorinės prekės“. Šiame sąraše yra įrašoma informacija, gauta iš e-parduotuvės ir naudojantis šia informacija bus kuriama BC prekės kortelė. Sąraše esantys laukai, kurie nesutampa su standartiniai BC prekių laukais, ir jų reikšmės pateiktos žemiau.

Iš šio sąrašo galima pamatyti papildomą informaciją apie prekės:

• Matavimo vienetus;
• Prekių nuorodas;
• Vertimus.

Taip pat, galima rankiniu būdu inicijuoti prekės kūrimą naudojant funkciją „Kurti prekę“. Kūrimo metu įvykus klaidai, ją peržiūrėti paspaudus „Rodyti klaidą“. O jei prekės kūrimas įvyko sėkmingai, nueiti į kortelę paspaudus „Prekės kortelė“.

Prekių kūrimas per API susideda iš dviejų žingsnių:

1. Per API plėtinį „eComExternalItems“ yra atsiunčiama informacija apie prekes. Užklausos adreso pavyzdys:
   {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComExternalItems
   Užklausos teksto pavyzdys:
   {
   "eComId": "",
   "shopCode": "",
   "description": "",
   "description2": "",
   "baseUnitOfMeasure": "",
   "itemCategoryCode": "",
   "netWeight": 0.00,
   "grossWeight": 0.00,
   "tariffNo": "",
   "countryRegionOfOriginCode": "",
   "vendorNo": "",
   "vendorItemNo": "",
   "templateCode": "",
   "additionalInfo1": "",
   "additionalInfo2": "",
   "additionalInfo3": "",
   "additionalInfo4": "",
   "additionalInfo5": "",
   "additionalInfo6": "",
   "additionalInfo7": "",
   "additionalInfo8": "",
   "additionalInfo9": "",
   "additionalInfo10": "",
   "eComExtItemUnitsOfMeasure": [
   {
   "code": "",
   "qtyPerUnitOfMeasure": 0.00,
   "length": 0.00,
   "width": 0.00,
   "height": 0.00,
   "cubage": 0.00,
   "weight": 0.00
   }
   ],
   "eComExtItemReferences": [
   {
   "referenceNo": "",
   "unitOfMeasure": "",
   "description": "",
   "description2": "",
   "startingDate": "",
   "endingDate": ""
   }
   ],
   "eComExtItemTranslations": [
   {
   "languageCode": "",
   "description": ""
   }
   ]
   }

2. Per API plėtinio „eComExternalItems“ funkciją „Microsoft.NAV.createBcItem“ yra inicijuojamas prekės kūrimas. Norint atlikti kūrimą, reikia turėti sukurtos „eCom išorinės prekės“ ID. Jis yra gaunamas su pirmos užklausos atsakymu.
   Užklausos adreso pavyzdys:
   {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComExternalItems({{externalItemID}})/Microsoft.NAV.createBcItem

PIRKĖJŲ KŪRIMAS

Prieš pirkėjų iš e-parduotuvės kūrimą, BC turi būti padaryti šie veiksmai:

• Reikiamoje „eCom parduotuvės“ kortelėje uždėti požymį „Kurti pirkėjus“ (jei šis požymis bus neigiamas, per API bus gaunama klaida bandant kurti pirkėjus;
• Reikiamai „eCom parduotuvei“ užpildyti sąrašą „eCom pard. pirkėjų kūrimo šablonai“. Šie šablonai bus naudojami pirkėjų kortelių kūrime.

Pirkėjų kūrimui yra naudojama tarpinis sąrašas „eCom išoriniai pirkėjai“. Šiame sąraše yra įrašoma informacija, gauta iš e-parduotuvės ir naudojantis šia informacija bus kuriama BC pirkėjo kortelė. Sąraše esantys laukai, kurie nesutampa su standartiniai BC pirkėjų laukais, ir jų reikšmės pateiktos žemiau.

Iš šio sąrašo galima rankiniu būdu inicijuoti pirkėjo kūrimą naudojant funkciją „Kurti pirkėją“. Kūrimo metu įvykus klaidai, ją peržiūrėti paspaudus „Rodyti klaidą“. O jei pirkėjo kūrimas įvyko sėkmingai, nueiti į kortelę paspaudus „Pirkėjo kortelė“.

Pirkėjų kūrimas per API susideda iš dviejų žingsnių:

1. Per API plėtinį „eComExternalCustomers“ yra atsiunčiama informacija apie pirkėją.
   Užklausos adreso pavyzdys:
   {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComExternalCustomers
   Užklausos teksto pavyzdys:
   {
   "eComId": "",
   "shopCode": "",
   "isBusiness": false,
   "registrationNo": "",
   "vatRegistrationNo": "",
   "name": "",
   "name2": "",
   "address": "",
   "address2": "",
   "postCode": "",
   "city": "",
   "countryCode": "",
   "eMail": "",
   "phoneNo": "",
   "additionalInfo1": "",
   "additionalInfo2": "",
   "additionalInfo3": "",
   "additionalInfo4": "",
   "additionalInfo5": ""
   }

2. Per API plėtinio „eComExternalCustomers“ funkciją „Microsoft.NAV.createBcCustomer“ yra inicijuojamas pirkėjo kūrimas. Norint atlikti kūrimą, reikia turėti sukurto „eCom išorinio pirkėjo“ ID. Jis yra gaunamas su pirmos užklausos atsakymu.
   Užklausos adreso pavyzdys:
   {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComExternalCustomers({{externalCustomerID}})/Microsoft.NAV.createBcCustomer

UŽSAKYMŲ KŪRIMAS

Prieš užsakymų iš e-parduotuvės kūrimą, BC turi būti per visus nustatymus, prekes ir pirkėjus. Svarbiausi punktai:

• Užpildyti „eCom nustatymus“;
• Užpildyti „eCom parduotuvių“ nustatymus;
• Pažymėti, kurios prekės yra eCom;
• Pažymėti, kurie pirkėjai yra eCom;
• Suderinti papildomuose nustatymuose naudojamos eCom kodus;
• Suderinti kada ir kokia informacija bus importuojama iš BC;
• Suderinti kada ir kokia informacija bus siunčiama į BC;

Užsakymų kūrimui yra naudojama tarpinis užsakymas „eCom užsakymas“ ir „eCom grąžinimo užsakymas“. Šiame sąraše yra įrašoma informacija, gauta iš e-parduotuvės ir naudojantis šia informacija bus kuriamas BC pardavimo užsakymas arba BC pardavimo grąžinimo užsakymas. Šių užsakymų kūrimo procesas yra analogiškas, skiriasi tik siunčiama informacija, todėl toliau bus detalizuojamas tik užsakymo kūrimas. eCom užsakymai detaliai aprašyti skyriuje „eCom užsakymai“, todėl šiame skyriuje bus aprašytas tik kūrimo procesas.

Užsakymų kūrimas per API susideda iš dviejų žingsnių:

1. Per API plėtinį „eComOrders“ yra atsiunčiama informacija apie užsakymą.
   Užklausos adreso pavyzdys:
   {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComOrders
   Užklausos teksto pavyzdys:
   {
   "eComOrderNo": "",
   "orderType": "",
   "shopCode": "",
   "scheduled": false,
   "createNewOrder": false,
   "eComCustomerId": "",
   "customerIsBusiness": false,
   "customerRegistrationNo": "",
   "customerVatRegistrationNo": "",
   "customerName": "",
   "customerName2": "",
   "customerAddress": "",
   "customerAddress2": "",
   "customerPostCode": "",
   "customerCity": "",
   "customerCountryCode": "",
   "customerEmail": "",
   "customerPhoneNo": "",
   "shipToName": "",
   "shipToName2": "",
   "shipToAddress": "",
   "shipToAddress2": "",
   "shipToPostCode": "",
   "shipToCity": "",
   "shipToCountryCode": "",
   "appliesToOrderNo": "",
   "returnReasonCode": "",
   "navInvoice": false,
   "orderDate": "0000-00-00",
   "postingDate": "0000-00-00",
   "shipmentDate": "0000-00-00",
   "currencyCode": "",
   "amount": 0.00,
   "amountIncludingVat": 0.00,
   "paymentTermsCode": "",
   "paymentMethodCode": "",
   "shipmentMethodCode": "",
   "shippingAgentCode": "",
   "useNavPrices": false,
   "shipmentLabel": "",
   "sellFromMarketplaceCode": "",
   "shipmentLManifest": "",
   "additionalInfo1": "",
   "additionalInfo2": "",
   "additionalInfo3": "",
   "additionalInfo4": "",
   "additionalInfo5": "",
   "eComOrderLines": [
   {
   "itemNumber": "",
   "crossReferenceNo": "",
   "description": "",
   "description2": "",
   "variantCode": "",
   "unitOfMeasure": "",
   "quantity": 0.00,
   "unitPrice": 0.00,
   "amount": 0.00,
   "amountIncludingVat": 0.00,
   "appliesToOrderNo": "",
   "returnReasonCode": "",
   "vatPerCent": 0,
   "additionalInfo1": "",
   "additionalInfo2": "",
   "additionalInfo3": "",
   "additionalInfo4": "",
   "additionalInfo5": "",
   "ecomOrderLineIncomingAttributes": [
   {
   "type": "",
   "code": "",
   "value": ""
   }
   ]
   }
   ],
   "eComOrderServiceLines": [
   {
   "serviceId": "",
   "serviceDescription": "",
   "servicePrice": 0.00,
   "amount": 0.00,
   "amountIncludingVat": 0.00
   }
   ],
   "eComOrderCouponLines": [
   {
   "couponTypeCode": "",
   "couponId": "",
   "couponDescription": "",
   "couponValue": 0.00
   }
   ]
   }

2. Per API plėtinio „eComOrders“ funkciją „Microsoft.NAV.createBcOrder“ yra inicijuojamas užsakymo kūrimas (netaisant BC esančių nustatymų, visada naudojama ta pati funkcija). Norint atlikti kūrimą, reikia turėti sukurto „eCom užsakymo“ ID. Jis yra gaunamas su pirmos užklausos atsakymu.
   Užklausos adreso pavyzdys:
   {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComOrders({{eComOrderID}})/Microsoft.NAV.createBcOrder

LISTINGŲ ATNAUJINIMAS

Softera.eCom produkte listingai yra kuriami BC ir importuojami į e-parduotuvę. Po importavimo, iš e-parduotuvės turi būti atnaujinti informacija apie listingui priskirtą unikalų ID. Taip yra užtikrinamas ryšys vienas su vienu tarp listingų.

Listingų atnaujinimas per API yra per šią užklausą:

Per API plėtinį „Listings“ yra atsiunčiama informacija apie listingą. Kartu su užklausa turi būti siunčiamas ir odata.tag reikšmė, kuri užtikrina jog po listingo nuskaitymo jis nebuvo atnaujintas.
Užklausos adreso pavyzdys:
{{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/listings({{listingID}})
Užklausos teksto pavyzdys:
{
"id": "",
"shopListingID": 0
}

EKSPORTUOJAMŲ DUOMENŲ PAVYZDŽIAI

Prekės

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/Items
• Galimi plėtiniai: itemTranslations,itemUnitsOfMeasure,itemReferences,itemAttributeMapValues,itemPictureUrls,itemVariants
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "no": "",
  "description": "",
  "description2": "",
  "baseUom": "",
  "salesUom": "",
  "grossWeight": 0,
  "netWeight": 0,
  "tariffNo": "",
  "minimumOrderQuantity": 0,
  "manufacturerCode": "",
  "itemCategoryCode": "",
  "lastDateModified": "",
  "lastDefinitionDateTimeModified": "",
  "salesBlocked": false,
  "additionalInfo": ""
  }

Prekių kategorijos

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/itemCategories
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "code": "",
  "description": "",
  "parentCategory": "",
  "additionalInfo": ""
  }

Prekių rūšys

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/itemVariants
• Galimi plėtiniai: itemTranslations,itemReferences,itemVariantAttributeValues,itemPictureUrls
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "code": "",
  "description": "",
  "description2": "",
  "additionalInfo": ""
  }

Išorinės prekės

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComExternalItems
• Galimi plėtiniai: eComExtItemUnitsOfMeasure,eComExtItemReferences,eComExtItemTranslations
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "eComId": "",
  "shopCode": "",
  "description": "",
  "description2": "",
  "baseUnitOfMeasure": "",
  "itemCategoryCode": "",
  "netWeight": 0,
  "grossWeight": 0,
  "tariffNo": "",
  "countryRegionOfOriginCode": "",
  "vendorNo": "",
  "vendorItemNo": "",
  "templateCode": "",
  "additionalInfo1": "",
  "additionalInfo2": "",
  "additionalInfo3": "",
  "additionalInfo4": "",
  "additionalInfo5": "",
  "additionalInfo6": "",
  "additionalInfo7": "",
  "additionalInfo8": "",
  "additionalInfo9": "",
  "additionalInfo10": ""
  }

Prekių atributai

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/itemAttributes
• Galimi plėtiniai: itemAttributeTranslations,itemAttributeValues($expand=itemAttributeValueTranslations)
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "attributeId": 0,
  "name": "",
  "blocked": false,
  "type": "",
  "unitOfMeasure": "",
  "additionalInfo": ""
  }

Prekių likučiai

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/itemInventory
• Galimi plėtiniai: itemVariantInventory
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "no": "",
  "referenceNo": "",
  "baseUom": "",
  "quantity": 0,
  "plannedReceiptDate": ""
  }

Vietų likučiai

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/locationInventory
• Galimi plėtiniai: itemInventory
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "code": "",
  "name": ""
  }

Listingai

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/listings
• Galimi plėtiniai: listingPictureUrls,listingTexts,listingItems($expand=itemAttributeValue)
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "code": "",
  "shopCode": "",
  "shopListingID": 0,
  "modelItemNumber": "",
  "modelItemDescription": "",
  "unitPrice": 0,
  "netWeight": 0,
  "status": "New",
  "lastDateTimeModified": "",
  "relatedEntries": 0,
  "includedEntries": 0
  }

Pirkėjai

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/customers
• Galimi plėtiniai: shipToAddresses,contacts
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "no": "",
  "eComId": "",
  "name": "",
  "name2": "",
  "address": "",
  "address2": "",
  "city": "",
  "contact": "",
  "phoneNo": "",
  "faxNo": "",
  "postCode": "",
  "email": "",
  "registrationNo": "",
  "currencyCode": "",
  "customerPriceGroup": "",
  "customerDiscGroup": "",
  "languageCode": "",
  "paymentTermsCode": "",
  "paymentTermsDescription": "",
  "paymentTermsDiscountPerCent": 0,
  "salespersonCode": "",
  "salespersonName": "",
  "salesPersonEmail": "",
  "salesPersonPhone": "",
  "countryRegionCode": "",
  "balanceLcy": 0,
  "balanceOverdueAmount": 0,
  "outstandingSalesOrders": 0,
  "creditLimitLcy": 0,
  "vatRegistrationNo": "",
  "vatBusPostingGroup": "",
  "partnerType": "",
  "shippingAdvice": "",
  "shippingTime": "",
  "netChangeLcy": 0,
  "balanceIsOverdue": true,
  "additionalInfo": ""
  }

Išoriniai pirkėjai

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComExternalCustomers
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "eComId": "",
  "shopCode": "",
  "isBusiness": false,
  "registrationNo": "",
  "vatRegistrationNo": "",
  "name": "",
  "name2": "",
  "address": "",
  "address2": "",
  "postCode": "",
  "city": "",
  "countryCode": "",
  "eMail": "",
  "phoneNo": "",
  "additionalInfo1": "",
  "additionalInfo2": "",
  "additionalInfo3": "",
  "additionalInfo4": "",
  "additionalInfo5": ""
  }

Pirkėjo SF statusas

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/customerInvoiceStatuses
• Būtini filtrai: shopCode, customerId
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "
  "id": "
  "shopCode": "",
  "customerId": "",
  "customerName": "",
  "customerName2": "",
  "documentNo": "",
  "postingDate": "",
  "isPaid": false,
  "remainingAmountLcy": 0
  }

Užsakymo statusas

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/orderStatuses
• Būtini filtrai: shopCode
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "shopCode": "",
  "orderNo": "",
  "dateTime": "",
  "orderType": "",
  "eComNo": "",
  "statusCode": ""
  }

Užregistruota SF

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/postedInvoices
• Būtini filtrai: shopCode, eComOrderNo
• Galimi plėtiniai: postedInvoiceLines,documentPdfFiles
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "shopCode": "",
  "no": "",
  "eComNo": "",
  "eComOrderNo": "",
  "externalDocumentNo": "",
  "currencyCode": "",
  "documentDate": "",
  "postingDate": "",
  "shipmentDate": "",
  "customerId": "",
  "pricesIncludingVAT": false,
  "amount": 0,
  "amountIncludingVAT": 0,
  "paymentTermsCode": "",
  "dueDate": "",
  "paymentDiscountPerCent": 0,
  "invoiceDiscountAmount": 0
  }

Užregistruota grąžinimo pažyma

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/postedCreditMemos
• Būtini filtrai: shopCode, eComOrderNo
• Galimi plėtiniai: postedCreditMemoLines,documentPdfFiles
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "
  "id": "",
  "shopCode": "",
  "no": "",
  "eComNo": "",
  "eComOrderNo": "",
  "externalDocumentNo": "",
  "currencyCode": "",
  "documentDate": "",
  "postingDate": "",
  "shipmentDate": "",
  "customerId": "",
  "pricesIncludingVAT": false,
  "amount": 0,
  "amountIncludingVAT": 0,
  "paymentTermsCode": "",
  "dueDate": "",
  "paymentDiscountPerCent": 0,
  "invoiceDiscountAmount": 0
  }

Pardavimo kaina

• Užklausos adreso pavyzdys: {{baseURL}}/{{environment}}/api/softera/eCom/v2.0/companies({{companyID}})/eComSalesPrices
• Atsakyme gaunama informacija:
  {
  "@odata.etag": "",
  "id": "",
  "itemNo": "",
  "variantCode": "",
  "unitOfMeasureCode": "",
  "minimumQuantity": 0,
  "salesType": "",
  "salesCode": "",
  "customereComId": "",
  "customerDiscGroup": "",
  "campaignCode": "",
  "currencyCode": "",
  "unitPrice": 0,
  "allowLineDiscount": true,
  "lineDiscountPerCent": 0,
  "unitPriceIncludingDiscount": 0,
  "pricesIncludingVAT": false,
  "vatPerCent": 0,
  "allowInvoiceDiscount": true,
  "createdDateTime": ""
  }