Add Line Item
To add a new line item, submit a POST request with the data to be updated as a string of dictionary.
Add a new line item
PUT
https://api.photoncommerce.com/api/v4/line-items
This method can be used to add one new line item at a time. The line item keys whose values can be added are listed in the code block after the following API method block.
Path Parameters
photon_key
string
Photon Key of the JSON file that needs to be updated
Headers
CLIENT-ID
string
Unique client-id provided upon user registration
AUTHORIZATION
string
Pass your username and api key in the form 'apikey <username>:<api-key>'
SECRET-KEY
string
Secret key provided as a string
PASSWORD
string
Password used during user registration
Content-Type
string
Set to "application/json"
Request Body
data
string
String of dictionary containing fields to be updated with their corresponding values e.g {'SKU': '003', 'Description': 'MacBook', 'Price': 1299, 'Amount': 1299}
{"message":"Added line item successfully","status":"success"}
Line item keys that can be added:
"SKU": <string- parsed SKU code>,
"Description": <string- raw item description>,
"Date": <date of the line item as a string "YYYY-MM-DD">,
"Order": <integer - Order of the item>,
"Reference": <string- Reference ID for the item>,
"QTY": <decimal number of units>,
"Unit": <unit of measure>,
"Price": <decimal unit price>,
"Amount": <decimal total pricing>,
"Discount": <decimal line item discount amount>,
"Tax_Rate": <the tax rate levied>,
"Tax", <decimal line item tax amount>,
"Type" <inferred product or service string>
Syntax for sending a POST request to add a new line item:
curl -X PUT -H 'Content-Type: application/json' -H "CLIENT-ID:<client-id>" -H "AUTHORIZATION:apikey <username>:<api-key>" -H 'PASSWORD:<password>' -H "SECRET-KEY:<secret-key>" -d '{'SKU': '003', 'Description': 'MacBook', 'Price': 1299, 'Amount': 1299}' "https://api.photoncommerce.com/api/v4/update/line-items?photon_key=<mention-the-photon-key-here>"
Last updated
Was this helpful?