Create receipt

Description

The call is used to send Receipt with product items to this or that storage owner in our system

Calling

POST /receipts

Parameters

{
  "storageId": "string",
  "qwqerId": "string",
  "status" : "string",
  "type" : "string",
  "trackingLink": "string",
  "items": [
    {
      "quantity": 0,
      "title": "string",
      "description": "string",
      "sku": "string",
      "link": "string",
      "sellerId": "string",
      "price": 0,
      "externalId": "string",
      "imageFullPath": "string",
      "specs": [
        {
          "id": "string",
          "value": "string"
        }
      ]
    }
  ],
  "boxes" : [
    {
      "externalId" : "string",
      "items" : [
        {
          // Item Object how in "items" root property
        }
      ]
    }
  ]
}

Parameter Key Name	Description
qwqerId	[ * ] Marketplace or Merchant UUID
storageId	[ * ] UUID of the selected storage for shipping your product items. To find the necessary storage use one of Get storage list API methods.
status	Receipt status (available values : new, sent (default is new)
type	Receipt type (available values : Box, Pallet (default is Box)
trackingLink	[ ** ] Link to track the package in your system. Used only to track by storage owner. ** - If receipt creating with sent status this field is required.
items	[ * ] List of products for current Receipt
boxes	[ * ] List of boxes with list of products for current Receipt

TIP

If type="Box" - required filled items property

If type="Pallet" - required filled boxes property

Each items object contains:

Parameter Key Name	Description
items.quantity	[ * ] Product quantity for receipt
items.title	[ * ] Product name
items.description	Product description
items.sku	[ * ] Product SKU (vendor code)
items.price	[ * ] Product price (used to calculate storage fees)
items.imageFullPath	[ * ] Direct url to the main product image on your server
items.specs	Product attributes. Available attributes can be obtained using Get Specs API method
items.sellerId	[ deprecated ] A unique seller identifier for a product on your marketplace.
items.externalId	[ * ] Unique identifier of a product in your marketplace. Used for further use and tracking of the product item in our system.

Required Specs

⚠️ Important

For invoicing, each item must include the following Specs:

incremental_id	title	uuid	type
4	Width	ed1ad7a8-1ad1-4984-81d6-3c58eabc6cf8	width
5	Height	e2b8e362-c34f-425d-a3e8-3704e880986e	height
6	Depth	3e5ffb1f-c85a-4bfe-b814-85261f4d94a5	depth
7	Weight	6dece039-5f5f-49e1-aa04-5259a02c499f	weight

Dimensions (Width, Height, Depth) must be specified in meters.

Weight must be specified in kilograms.

All of the above-mentioned specs should be of type float.

Response

200 - Successful request

{
  "receiptId": "string",  // UUID of created Receipt
  "status": "string",     // Status of created Receipt
  "items": [
    {
      "id": "string",         // UUID of product item
      "externalId": "string"  // Specified by you externalId in request
    }
  ],
  "boxes" : [
    {
      "id": "string",         // UUID of box
      "externalId": "string", // Specified by you externalId in request
      "items": [              // Product list of current box
        {
          "id": "string",
          "externalId": "string"
        }
      ]
    }
  ]
}

WARNING

If a product item with externalId already exists in the selected warehouse, this product item will not be created, you will receive its UUID in the id field for this item and all information about it will be completely ignored

400 - Invalid request

{
  "message": "string"
}