I den här artikeln använder vi metoden SubmitShipment i API:et för att skapa/boka en försändelse
https://nshiftship.zendesk.com/hc/sv/articles/23142488632988#post_shipments
Men beroende på flödet du implementerar kan någon av följande metoder vara ett bättre alternativ:
- https://nshiftship.zendesk.com/hc/sv/articles/23142488632988#post_saveshipment
- https://nshiftship.zendesk.com/hc/sv/articles/23142488632988#post_importUpload
- https://nshiftship.zendesk.com/hc/sv/articles/23142488632988#post_orderAdvice
- https://nshiftship.zendesk.com/hc/sv/articles/23142488632988#post_submitOrder
Innan du fortsätter, ta gärna en titt på följande avsnitt i API-dokumentationen:
https://nshiftship.zendesk.com/hc/sv/articles/23142488632988#post_shipments_options
https://nshiftship.zendesk.com/hc/sv/articles/23093866504604-Shipment-Data-Object
Miljö-URL
Exempel på hur man bokar en försändelse
Dataobjektet definierar försändelsen, och Optionsobjektet tillhandahåller konfiguration för metoden.
Exempel 1. (enkel paketförsändelse)
Exempel 2. (flera paket med samma vikt)
Exempel 3. (flera paket med olika vikter)
Exempel 1. (enkel paketförsändelse)
curl -s -X POST "{{URL}}/ShipServer/{{ACTOR_ID}}/Shipments"
-H "Authorization: {{TOKEN}}"
-H "Content-Type: application/json"
--data-raw "{
\"data\": {
\"ProdConceptID\": 1782,
\"OrderNo\": \"Test Shipment 1\",
\"Addresses\": [{
\"Kind\": 1,
\"Name1\": \"Test Receiver Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 7400,
\"City\": \"Herning\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
},{
\"Kind\": 2,
\"Name1\": \"Test Sender Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 6400,
\"City\": \"Sønderborg\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
}],
\"Lines\":[{
\"Number\": 1,
\"PkgWeight\": 10000,
\"Height\": 100,
\"Length\": 100,
\"Width\": 100,
\"GoodsTypeID\": 13,
\"References\": [{
\"Kind\": 23,
\"Value\": \"Test Shipment - Do not process !\"
}]
}]
},
\"options\": { \"Labels\": \"ZPLGK\" }
}"Exempel 2. (flera paket med samma vikt)
curl -s -X POST "{{URL}}/ShipServer/{{ACTOR_ID}}/Shipments"
-H "Authorization: {{TOKEN}}"
-H "Content-Type: application/json"
--data-raw "{
\"data\": {
\"ProdConceptID\": 1782,
\"OrderNo\": \"Test Shipment 1\",
\"Addresses\": [{
\"Kind\": 1,
\"Name1\": \"Test Receiver Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 7400,
\"City\": \"Herning\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
},{
\"Kind\": 2,
\"Name1\": \"Test Sender Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 6400,
\"City\": \"Sønderborg\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
}],
\"Lines\":[{
\"Number\": 2,
\"PkgWeight\": 10000,
\"Height\": 100,
\"Length\": 100,
\"Width\": 100,
\"GoodsTypeID\": 13,
\"References\": [{
\"Kind\": 23,
\"Value\": \"Test Shipment - Do not process !\"
}]
}]
},
\"options\": { \"Labels\": \"ZPLGK\" }
}"Exempel 3. (flera paket med olika vikter)
curl -s -X POST "{{URL}}/ShipServer/{{ACTOR_ID}}/Shipments"
-H "Authorization: {{TOKEN}}"
-H "Content-Type: application/json"
--data-raw "{
\"data\": {
\"ProdConceptID\": 1782,
\"OrderNo\": \"Test Shipment 1\",
\"Addresses\": [{
\"Kind\": 1,
\"Name1\": \"Test Receiver Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 7400,
\"City\": \"Herning\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
},{
\"Kind\": 2,
\"Name1\": \"Test Sender Name1\",
\"Street1\": \"Test Road 1\",
\"PostCode\": 6400,
\"City\": \"Sønderborg\",
\"CountryCode\": \"DK\",
\"Phone\": \"12341234\",
\"Mobile\": \"12341234\",
\"Email\": \"noreply@nshift.com\",
\"Attention\": \"Test Attention\"
}],
\"Lines\":[{
\"Number\": 1,
\"PkgWeight\": 10000,
\"Height\": 100,
\"Length\": 100,
\"Width\": 100,
\"GoodsTypeID\": 13,
\"References\": [{
\"Kind\": 23,
\"Value\": \"Test Shipment - Do not process !\"
}]
},{
\"Number\": 1,
\"PkgWeight\": 15000,
\"Height\": 100,
\"Length\": 100,
\"Width\": 100,
\"GoodsTypeID\": 13,
\"References\": [{
\"Kind\": 23,
\"Value\": \"Test Shipment - Do not process !\"
}]
}]
},
\"options\": { \"Labels\": \"ZPLGK\" }
}"
Svar
Alla exempel genererar ett svar som det nedan
{
"ShpCSID": 161323,
"ShpNo": "70730254433124072",
"OrderNo": "Test Shipment 1",
"ProdConceptID": 1782,
"Addresses": [...],
"Lines": [...],
"Labels": [{
"Content": "XlhBXkNXSSxFOlotRVB...",
"Type": 13,
"Copies": 1,
"PkgCSID": 162500,
"PkgNo": "00370730254433124088"
}, {
"Content": "XlhBXkNXSSxFOlotRVB...",
"Type": 13,
"Copies": 1,
"PkgCSID": 162501,
"PkgNo": "00370730254433124095"
}
],
"ShpDocuments": [{
"ShpCSID": 161323,
"DocumentID": 1217,
"DocumentCSID": 165178,
"Copies": 1,
"DocumentName": "Generic Sweden",
"PrintedDt": "2022-08-04T12:56:40",
"DocumentType": "Label"
}, {
"ShpCSID": 161323,
"DocumentID": 104,
"DocumentCSID": 165179,
"Copies": 1,
"DocumentName": "SE.Fraktsedel",
"PrintedDt": "2022-08-04T12:56:40",
"DocumentType": "FreightLetter"
}
]
}- Labels[0].Content - Etiketterna returneras i det begärda formatet, men är kodade med base64
- ShpDocuments - Information om genererade etiketter och dokument
-
ShpDocuments[1].ShpCSID - använd metoden get_documents för att hämta dokumenten
https://nshiftship.zendesk.com/hc/sv/articles/23142488632988-API-Documentation#get_documents