POST
/
v1
/
orders
Create
curl --request POST \
  --url https://third-party.etrnl.app/v1/orders \
  --header 'API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "<string>",
  "tagMetadata": "<string>",
  "shippingLabelImgUrl": "<string>"
}'
{
      success: true,
	  err: '',
      order: {
        id: 17,
        organizationId: 681,
        productId: 91,
        displayName: "John's order",
        creationDate: "2023-09-26T23:19:42.000Z",
        fulfilled: false,
        tagMetadata: { internalOrderId: 123456 },
        shippingLabelImgUrl: "https://example.com/johns-shipping-label.png",
        fulfillmentDate: null
      }
    }
Create a new order for a product

​
Headers

​
API-Key
string
required
Your organization’s private API key.

​
JSON Request Body

​
displayName
string
This is the order’s display name as it will appear in the programmer.
​
tagMetadata
string
This is a JSON object that defines additional information that will be tied to the tag that’s programmed for the order.
​
shippingLabelImgUrl
string
This is an optional field where you can add your customer’s shipping label. This will allow you to print the shipping label directly from the programmer.
{
      success: true,
	  err: '',
      order: {
        id: 17,
        organizationId: 681,
        productId: 91,
        displayName: "John's order",
        creationDate: "2023-09-26T23:19:42.000Z",
        fulfilled: false,
        tagMetadata: { internalOrderId: 123456 },
        shippingLabelImgUrl: "https://example.com/johns-shipping-label.png",
        fulfillmentDate: null
      }
    }