createSale

POST data

(if any - change request to POST, put those in as form-data)

• fkshipmenttype | required

  integer

  Shipment type internal identifier

• fkpaymenttype | required

  integer

  Payment type internal identifier

• doc_type | required

  string

  Which document should be assigned to sale. Available: "receipt" or "invoice"

• shipment_diff_invoice

  boolean (1 = true, 0 = false)

  Points whether shipping address is different from client (invoice) address. If set to yes, you have to fill "shipping" data This field is mandatory if you are using a drop-shipping client

• currency

  string

  Currency symbol. If omitted - account currency will be picked

  Example: Three letters format ie: PLN, EUR, USD.

• is_assembling

  boolean (1 = true, 0 = false)

  Points whether order is going to be modified or more products added

• pickup_point

  string

  Unique ID of selected pickup point. Required only if fkshipmenttype points at the pickup point delivery type. This field replaces 6 old separate fields for each pickup point delivery shipment type. - For Poczta Polska - it's PNI, - For DHL - it's SAP

• notice

  string

  Order's notice

• products | required

  object[]

  An array with requested products.

  Nested fields:

  • id | required

    integer

    Product internal ID

  • qty | required

    float

    Product quantity you want to order

• shipping

  object

  Array with shipping address - required only if "shipment_diff_invoice" = true

  Nested fields:

  • receiver_name | required

    string

    Receiver's full name / company name

  • postal_code | required

    string

    Receiver's postal code

  • city | required

    string

    Receiver's city

  • street | required

    string

    Receiver's street

  • home_number

    string

    Receiver's building number

  • flat_number

    string

    Receiver's flat nummber

  • phone | required

    string

    Receiver's phone number

  • email | required

    string

    Receiver's email address

  • country | required

    string

    Receiver's country - ISO2 code

    Example: Two letters format ie: DE, PL, GB, US

• own_label

  object

  Array with information about supplied own label. Required and processed only if you have selected a valid delivery method. Allows customer to send us their own delivery label for the package (as long as given provider is supported by us). Since 10th November 2022 it is possible to upload multiple files.
  To get a valid fkshipmenttype value for this option - please refer to either of those methods: getAvailableDeliveryOptions, getShipmentTypes.

  Nested fields:

  • mode | required

    string

    Allows us to identify which field should be use for file validation. Following values are allowed: pdf, url

  • provider

    string

    Delivery carrier for given label. Following values are allowed: dpd, dhl, inpost, pocztapolska, ups, orlen, emag, olzalogistic

  • items

    object[]

    Array with data for each given label

    Nested fields:

    • url

      string

      URL address which points to your PDF label file. Make sure that given endpoint returns the correct PDF file and has 'Content-Type' header equal to 'application/pdf'. Required if mode = url

    • data

      string

      Base64 string with valid PDF inside. Required if mode = pdf

    • tracking_no | required

      string

      Comma separated tracking numbers from given label. If only one label is passed then put here that one tracking number.