Inbounds

Inbounds — Let us know what products are on the way. On this page, we'll dive into the different inbound endpoints you can use to manage inbounds programmatically. We'll look at how to query, create, update, and delete inbounds.

The inbound model

The inbound model contains all the information about inbounds, such as their ref, expectedReceiveDate and contents.

Properties

  • Name
    ref
    Type
    string
    Description

    Unique reference that identifies the inbound.

  • Name
    type
    Type
    enum
    Description

    The type of the inbound. Valid values: purchase, return

  • Name
    supplierRef
    Type
    string
    maxLength(35)
    Description

    The reference as given by the sender, helping us recognizing the inbound as it comes in

  • Name
    expectedReceiveDate
    Type
    date
    Description

    The date when we can expect to receive the products

  • Name
    senderName
    Type
    string
    maxLength(100)
    Description

    The name of the sender

  • Name
    senderEmail
    Type
    string
    maxLength(80)
    Description

    The email address of the sender

  • Name
    senderPhonenumber
    Type
    string
    Description

    The phonenumber of the sender

  • Name
    senderAddressLine1
    Type
    string
    maxLength(100)
    Description

    Address Line 1 of the sender

  • Name
    senderAddressLine2
    Type
    string
    maxLength(100)
    Description

    Address Line 2 of the sender

  • Name
    senderPostCode
    Type
    string
    maxLength(20)
    Description

    The zipcode of the sender

  • Name
    senderCity
    Type
    string
    maxLength(30)
    Description

    The city of the sender

  • Name
    senderCountryCode
    Type
    string
    maxLength(2)
    Description

    The code for the country of the sender

  • Name
    status
    Type
    enum
    Description

    The status of the inbound. Valid values: new, in_progress, partially_received, fully_received, cancelled

  • Name
    lines
    Type
    array
    Description

    The collection containing the lines for this inbound. Refer to the inboundLine model on this page to see the properties for an inboundLine.

  • Name
    receipts
    Type
    array
    Description

    The collection containing the receipts for this inbound. Refer to the receipt model to see the properties for a receipt.

GET/fulfilment/v3/inbounds?skip=:skip&take=:take

List your inbounds

This endpoint allows you to retrieve a list of inbounds.

Optional arguments

  • Name
    skip
    Type
    number
    Description

    How many inbounds to skip

  • Name
    take
    Type
    number
    Description

    How many inbounds to return. Minimum for this argument is 10 maximum is 100

  • Name
    filter
    Type
    filter
    Description

    Consult the filtering guide for more information.

  • Name
    change-interval
    Type
    integer
    Description

    Get all records that have changed in the last change-interval minutes. Value between 5 and 2800

    Allthough we support polling. We recommend using webhooks. If you are going to poll please use this property to keep traffic manageable.

  • Name
    include
    Type
    enum
    Description

    The releated record to include. Valid values: lines, receipts

Request

GET
/v3/inbounds
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds \
  --header "Authorization: Bearer {token}" \

Response

[
{
    "ref": "REF0022312311",
    "type": "purchase",
    "supplierRef": "SUPREF12310238",
    "expectedReceiveDate": "2023-12-20",
    "senderName": "Harry Jansen",
    "senderEmail": "harry@jansen.nl",
    "senderPhonenumber": "0614525252",
    "senderAddressLine1": "Boermarkeweg 1",
    "senderAddressLine2": "",
    "senderPostCode": "7823 GA",
    "senderCity": "Emmen",
    "senderCountryCode": "NL",
    "status": "partially_received",
    "lines": [
        {
            "ref": "REF0022312311:s01",
            "quantity": 10000,
            "quantityReceived": 10000,
            "sku": "happy1"
        },
        {
            "ref": "REF0022312311:s02",
            "quantity": 42,
            "quantityReceived": 0,
            "sku": "happy2"
        },
        {
            "ref": "REF0022312311:s03",
            "quantity": 1,
            "quantityReceived": 1,
            "sku": "happy3"
        }
    ],
    "receipts": [
        {
            "receiptDate": "2023-12-20",
            "vendorShipmentNo": "SUPREF12310238",
            "lines": [
                {
                    "quantity": 1,
                    "defective": false,
                    "sku": "happy1",
                    "inboundRef": "REF0022312311",
                    "inboundLineRef": "REF0022312311:s01"
                }
            ]
        },
        {
            "receiptDate": "2023-12-21",
            "vendorShipmentNo": "SUPREF12310238",
            "lines": [
                {
                    "quantity": 9999,
                    "defective": false,
                    "sku": "happy1",
                    "inboundRef": "REF0022312311",
                    "inboundLineRef": "REF0022312311:s01"
                }
            ]
        },
        {
            "receiptDate": "2023-12-20",
            "vendorShipmentNo": "SUPREF12310238",
            "lines": [
                {
                    "quantity": 1,
                    "defective": false,
                    "sku": "happy3",
                    "inboundRef": "REF0022312311",
                    "inboundLineRef": "REF0022312311:s03"
                }
            ]
        }
    ]
},
{
    ...
},
]
POST/fulfilment/v3/inbounds/

Create an inbound

This endpoint allows you to add an inbound and it's lines.

Required attributes

  • Name
    body
    Type
    json
    Description

    json containing the inbound to create. Refer to the inbound model at the top of this page to see the properties we support.

Optional attributes

  • Name
    include
    Type
    enum
    Description

    The releated record to include. Valid values: lines, receipts

Please make sure to supply enough information for us to recognize the inbound when we receive it. For an purchase inbound the supplierRef should be the purchaseordernumber as present on the packing slip.

Request

POST
/fulfilment/v3/inbounds
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds \
  --header "Authorization: Bearer {token}" \
  --data '{
        "ref": "3234425353",
        "type": "purchase",
        "supplierRef": "3SHEU3323672323",
        "expectedReceiveDate": "2023-05-31",
        "senderName": "Harry Jansen",
        "senderEmail": "harry@jansen.nl",
        "senderPhonenumber": "0614525252",
        "senderAddressLine1": "Boermarkeweg 1",
        "senderAddressLine2": null,
        "senderPostCode": "7823 GA",
        "senderCity": "Emmen",
        "senderCountryCode": "NL",
        "lines": [
          {
            "sku": "SKUAPI02",
            "ref": "3234425353.01",
            "quantity": 100
          },
          {
            ...
          }
        ]

      }

Response

{
    "ref": "3234425353",
    "type": "purchase",
    "supplierRef": "3SHEU3323672323",
    "expectedReceiveDate": "2023-05-31",
    "senderName": "Harry Jansen",
    "senderEmail": "harry@jansen.nl",
    "senderPhonenumber": "0614525252",
    "senderAddressLine1": "Boermarkeweg 1",
    "senderAddressLine2": "",
    "senderPostCode": "7823 GA",
    "senderCity": "Emmen",
    "senderCountryCode": "NL",
    "status": "new",
    "lines": [
        {
            "ref": "3234425353.01",
            "quantity": 100,
            "quantityReceived": 0,
            "sku": "SKUAPI02"
        }
    ],
    "receipts": []
}
GET/fulfilment/v3/inbounds/:ref

Retrieve a inbound

This endpoint allows you to retrieve a inbound by providing the ref. Refer to the inbound model at the top of this page to see which properties are included with inbound objects.

Required attributes

  • Name
    ref
    Type
    string
    Description

    Path parameter representing your ref of the inbound.

Optional attributes

  • Name
    include
    Type
    enum
    Description

    The releated record to include. Valid values: lines, receipts

Request

GET
/fulfilment/v3/inbounds/3234425353
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/3234425353 \
  --header "Authorization: Bearer {token}"

Response

{
  "ref": "3234425353",
  "type": "purchase",
  "supplierRef": "3SHEU3323672323",
  "expectedReceiveDate": "2023-05-31",
  "senderName": "Harry Jansen",
  "senderEmail": "harry@jansen.nl",
  "senderPhonenumber": "0614525252",
  "senderAddressLine1": "Boermarkeweg 1",
  "senderAddressLine2": "",
  "senderPostCode": "7823 GA",
  "senderCity": "Emmen",
  "senderCountryCode": "NL",
  "status": "new",
  "lines": [
      {
          "ref": "3234425353.01",
          "quantity": 100,
          "quantityReceived": 0,
          "sku": "SKUAPI02"
      }
      {
        ...
      }
  ],
  "receipts": []
}
PUT/fulfilment/v3/inbounds/:ref

Update an inbound

This endpoint allows you to perform an update on an inbound. Examples of updates are changing the expectedReceiveDate or senderRef.

Although we support adding lines to the header in the post we do not support this in an update.

Required attributes

  • Name
    ref
    Type
    string
    Description

    Path parameter representing your ref of the outbound.

  • Name
    body
    Type
    string
    Description

    A json body containing the new values.

Optional attributes

  • Name
    include
    Type
    enum
    Description

    The releated record to include. Valid values: lines, receipts

Request

PUT
/fulfilment/v3/inbounds/3234425353
curl --location --request PUT https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/3234425353 \
  --header "Authorization: Bearer {token}" \
  --data '{
        "supplierRef": "NEWREF",
        "expectedReceiveDate": "2025-02-01,
        "senderName": "...",
        "senderEmail": "...",
        "senderPhonenumber": "...",
        "senderAddressLine1": "...",
        "senderAddressLine2": "...",
        "senderPostCode": "...",
        "senderCity": "...",
        "sendeeCountryCode": "..."
  }'

Response

{
"ref": "3234425353",
"type": "purchase",
"supplierRef": "NEWREF",
"expectedReceiveDate": "2024-02-01",
"senderName": "Harry Jansen",
"senderEmail": "harry@jansen.nl",
"senderPhonenumber": "0614525252",
"senderAddressLine1": "Boermarkeweg 1",
"senderAddressLine2": "",
"senderPostCode": "7823 GA",
"senderCity": "Emmen",
"senderCountryCode": "NL",
"status": "new",
"lines": [
    {
        "ref": "3234425353.01",
        "quantity": 100,
        "quantityReceived": 0,
        "sku": "SKUAPI02"
    },
    { 
      ...
    }
  ],
  "receipts": [],
},
DELETE/fulfilment/v3/inbounds/:ref

Delete an inbound

When we have received anything for the inbound you cannot delete it.

This endpoint allows you to delete inbounds. Note: This will permanently delete the inbound.

Required attributes

  • Name
    ref
    Type
    string
    Description

    Path parameter representing your ref of the outbound.

Request

DELETE
/fulfilment/v3/inbounds/3234425353
curl --location --request DELETE https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/3234425353 \
  --header "Authorization: Bearer {token}"

The inboundLine model

The inboundLine model contains all the information about inboundlines, such as their product, quantity and quantityReceived.

Properties

  • Name
    ref
    Type
    string
    Description

    Unique reference that identifies the inboundLine

  • Name
    sku
    Type
    string
    Description

    Unique reference to the product for the inboundLine

  • Name
    quantity
    Type
    integer
    Description

    The number of items to receive on this inboundLine

  • Name
    quantityReceived
    Type
    integer
    Description

    The number of items received on this inboundLine

GET/fulfilment/v3/inbounds/:ref/lines?skip=:skip&take=:take

List the lines for an inbound

This endpoint allows you to retrieve the lines for an inbound.

Required arguments

  • Name
    ref
    Type
    url param
    Description

    Your ref for the inbound to get the lines for.

Optional arguments

  • Name
    skip
    Type
    number
    Description

    How many lines to skip

  • Name
    take
    Type
    number
    Description

    How many lines to return. Minimum for this argument is 10 maximum is 100

Request

GET
/v3/inbounds/:ref/lines
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/202303221138002/lines \
  --header "Authorization: Bearer {token}" \

Response

[
  {
    "ref": "202303221138002:01",
    "quantity": 100,
    "quantityReceived": 10,
    "sku": "LI00P01"
  },
  {
    ...
  }
]
POST/fulfilment/v3/inbounds/:ref/lines

Create an inboundLine

This endpoint allows you to add a inboundLine to an existing inbound.

Required attributes

  • Name
    body
    Type
    json
    Description

    json containing the inboundLine to create. Refer to the inboundLine model to see the properties we support.

Request

POST
/fulfilment/v3/inbounds/:ref/lines
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/202303221138002/lines \
  --header "Authorization: Bearer {token}" \
  --data '{
    "sku": "SKUAPI02",
    "ref": "3234425353.03",
    "quantity": 42
  }

Response

{
  "ref": "202303221138002:11",
  "sku": "SKUAPI02",
  "quantity": 42,
  "quantityReceived": 0
}
GET/fulfilment/v3/inbounds/:ref/lines/:lineRef

Retrieve a inboundLine

This endpoint allows you to retrieve a inboundLine by providing your refs for the inbound and line. Refer to the inbound model to see which properties are included with inboundLine objects.

Request

GET
/fulfilment/v3/inbounds/:ref/lines/:lineRef
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/202303221138002/lines/202303221138002:01 \
  --header "Authorization: Bearer {token}"

Response

{
    "ref": "202303221138002:01",
    "quantity": 100,
    "quantityReceived": 0,
    "sku": "LI00P01"
}
PUT/fulfilment/v3/inbounds/:ref/lines/:lineRef

Update an inboundLine

This endpoint allows you to perform an update on an inboundLine. Examples of updates are changing the quantity.

Required attributes

  • Name
    body
    Type
    string
    Description

    A json body containing the new values. Refer to the inboundLine model to see the properties we support.

Request

PUT
/fulfilment/v3/inbounds/:ref/lines/:lineRef
curl --location --request PUT https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/202303221138002/lines/202303221138002:01 \
  --header "Authorization: Bearer {token}" \
  --data '{
    "quantity": 46
  }'

Response

{
    "ref": "202303221138002:01",
    "quantity": 46,
    "quantityReceived": 0,
    "sku": "LI00P01"
}
DELETE/fulfilment/v3/inbounds/:ref/lines/:lineRef

Delete an inboundLine

When we have received anything for the inboundLine you cannot delete it.

This endpoint allows you to delete an inboundLine. Note: This will permanently delete the inboundLine.

Request

DELETE
/fulfilment/v3/inbounds/:ref/lines/:lineRef
curl --location --request DELETE https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/202303221138002/lines/202303221138002:02 \
  --header "Authorization: Bearer {token}"
GET/fulfilment/v3/inbounds/:ref/label

Shipping label

Use this endpoint to get a shipping label for your customer, to be used to return items to your inventory.

To get a shipping label these fields are required: senderName, senderAddressLine1, senderPostCode, senderCity, senderCountryCode.

Request

GET
/fulfilment/v3/inbounds/:ref/label
curl --location https://partner.punt-uit.nl/api/fulfilment/v3/inbounds/202303221138002/label \
  --header "Authorization: Bearer {token}"

Response

JVBERi0xLjcKJYGBgYEKCjUgMCBvYmoKP...JlYW0KZW5kb2JqCgpzdGFydHhyZWYKMTIyODcKJSVFT0Y=

The response is a base64 encoded pdf document.