Sign in
Sales

Insert a sale or cancel committed quantities

Changed on

Inserts sales with billing customer, shipping customer, items, taxes and optional discounts. Customers are located by email address; missing customers are created and changed customer name/address details are updated.

To cancel all committed quantities associated with an order that will not be processed, send a sale record with the order number, store code and a sale total of 0.00, as shown in the source document.

post/Sale

Request

  • Base URL: https://api.myposconnect.com/api/v2
  • URL: https://api.myposconnect.com/api/v2/Sale
  • Auth: HTTP bearer

Request body

Example request

{
  "Sales": [
    {
      "SaleDate": "2019-08-07T18:00:00",
      "SaleTotal": "10.00",
      "Items": [
        {
          "Quantity": "10.00",
          "UnitPrice": "10.00",
          "TaxRate": "10.00",
          "TaxAmount": "10.00"
        }
      ],
      "Subtotal": "10.00",
      "Discount": {
        "Amount": -1,
        "Name": "General Discount"
      },
      "Taxes": [
        {
          "TaxRate": "10.00",
          "TaxTotal": "10.00"
        }
      ],
      "TaxTotal": "10.00"
    }
  ]
}

Response

Sale inserted.

unknown required

Changes

  • 25ec65796a4fRevision changes
    • breaking

      the / request property type changed from object to no type

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added to the / request property oneOf list

  • 3f7cebe5efd8Revision changes
    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added the new required request property ////

    • breaking

      added to the //// request property allOf list

    • breaking

      added to the // request property allOf list

    • breaking

      added subschema #2 to the // request property allOf list

    • breaking

      the request property //// became required

    • breaking

      the request property //// became required

    • breaking

      the request property // became required

    • breaking

      the request property's minItems was increased to 1

    • breaking

      the // request property's minItems was increased to 1

    • breaking

      removed subschema #1 subschema #2 from the // request property oneOf list

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2}(?:T\d{2}:\d{2}:\d{2}(?:\.\d+)?)?$ to the request property //

    • breaking

      the // request property type changed from object to no type

    • breaking

      the //// request property type changed from number to no type, and format from double to no format

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property //

    • warning

      removed the request property ////

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property ////

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request required property became write-only