Nyehandel
  1. Order
Nyehandel
  • Introduction
  • Getting started
  • Webhooks
  • API Reference
  • Order
    • Get order
      GET
    • Get orders
      GET
    • Create order
      POST
    • Deliver order
      POST
  • Shipping Method
    • Get Shipping methods
      GET
  • Product
    • Relation between products and variants
    • Get products
      GET
    • Update products batch
      PUT
    • Create products batch
      POST
    • Create product
      POST
    • Update product
      PUT
    • Create variant
      POST
    • Find product by sku or id
      GET
    • Delete product
      DELETE
  • Variant
    • Update variant batch
      PUT
    • Update variant
      PUT
    • Delete product variant
      DELETE
    • Find variant
      GET
  • Payment Method
    • Get Payment methods
      GET
  • Customer
    • Get Customer
      GET
    • Get Customers
      GET
    • Create Customer
      POST
  • Category
    • Create category
    • Update category
    • Get category
    • Delete category
    • Get categories
  • Currency
    • Get currencies
  • Headless
    • Pages
      • Get Page
      • Get Pages
    • Categories
      • Get Category
      • Get Pages
    • Startpage
    • System
  1. Order

Deliver order

POST
/orders/{order_id}/deliver
Can be used by external systems to send shipment booking data to Nyehandel. The order in Nyehandel will change status to "shipped" when deliver is triggered.
NOTE: The pdfs attached in pdf_paths will not be downloaded and copied to our filesystem, so we expect the pdf's to remain on the path sent.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/orders//deliver' \
--header 'Content-Type: application/json' \
--data-raw '{
    "complete_delivery": true,
    "pdf_paths": [
        "http://example.com"
    ],
    "parcels": [
        {
            "tracking_id": "string",
            "tracking_url": "string"
        }
    ]
}'
Response Response Example
{}

Request

Path Params
order_id
string 
required
Body Params application/json
complete_delivery
boolean 
required
pdf_paths
array[string <uri>]
required
Url paths to waybill PDF's
parcels
array [object {2}] 
required
Each parcel that is sent
tracking_id
string 
required
The tracking ID used to manually track the parcel
tracking_url
string 
required
An complete URL to where the customer can track the parcel
Examples

Responses

🟢200Success
application/json
Body
object {0}
Previous
Create order
Next
Get Shipping methods
Built with