Receipts

Receipts of inventory, be it purchases or returns. Get receipts and know your inventory.

The receipt model

The receipt model contains all the information about the receipts used in your proposition.

Properties

Name
id
Type
string
Description
A generated unique identifier for the receipt.
Name
receiptDate
Type
date
Description
The date on wich the items are received.
Name
vendorShipmentNo
Type
string
Description
The shipment number assigned to the receipt by the vendor
Name
lines
Type
array
Description
The collection containing the receipt lines for this receipt. Refer to the receiptLine model to see the properties for a line.
Name
inbound
Type
object
Description
The inbound this receipt belongs to. Refer to the inbound model to see the properties for a inbound.

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

List your receipts

This endpoint allows you to retrieve a list of receipts.

Optional arguments

Name
skip
Type
number
Description
How many shipments to skip
Name
take
Type
number
Description
How many shipments 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, inbound

Request

GET

/v3/receipts

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

Response

[
  [
    {
      "id": "clpi6falp0004ju08bqpa5sn6",
      "receiptDate": "2023-11-28",
      "vendorShipmentNo": "603145",
      "lines": [
          {
              "quantity": 1,
              "defective": false,
              "sku": "15134",
              "inboundRef": "20230285",
              "inboundLineRef": "20230285-30000"
          },
          {
            ...
          }
      ],
      "inbound": {
          "ref": "20230285",
          "type": "purchase",
          "supplierRef": "Einhell",
          "expectedReceiveDate": "2023-11-28",
          "senderName": null,
          "senderEmail": null,
          "senderPhonenumber": null,
          "senderAddressLine1": null,
          "senderAddressLine2": null,
          "senderPostCode": null,
          "senderCity": null,
          "senderCountryCode": null,
          "status": "fully_received"
      }
    },
    {
      ...
    }
  ]

GET/fulfilment/v3/receipts/:id

Retrieve a receipt

This endpoint allows you to retrieve a receipt by providing the id. The id is supplied in the webhook for receipt-received

Required arguments

Name
id
Type
string
Description
Path parameter representing the id of the receipt.

Optional arguments

Name
include
Type
enum
Description
The releated record to include. Valid values: lines, inbound

Request

GET

/fulfilment/v3/receipts/:id

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

Response

  {
    "id": "clpi6falp0004ju08bqpa5sn6",
    "receiptDate": "2023-11-28",
    "vendorShipmentNo": "603145",
    "lines": [
        {
            "quantity": 1,
            "defective": false,
            "sku": "15134",
            "inboundRef": "20230285",
            "inboundLineRef": "20230285-30000"
        }
    ],
    "inbound": {
        "ref": "20230285",
        "type": "purchase",
        "supplierRef": "Einhell",
        "expectedReceiveDate": "2023-11-28",
        "senderName": null,
        "senderEmail": null,
        "senderPhonenumber": null,
        "senderAddressLine1": null,
        "senderAddressLine2": null,
        "senderPostCode": null,
        "senderCity": null,
        "senderCountryCode": null,
        "status": "fully_received"
    }
},

The receiptLine model

The receiptLine model contains all the information about receiptLines, such as their sku, inboundRef, inboundLineRef and quantity.

Properties

Name
sku
Type
string
Description
The unique sku for the product that has been received.
Name
inboundRef
Type
string
Description
Your unique reference for the inbound.
Name
inboundLineRef
Type
string
Description
Your unique reference for the inboundLine
Name
quantity
Type
integer
Description
The number of items that have been received.