POST
/
v1
/
orders
Create Order
curl --request POST \
  --url https://api.zinc.io/v1/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "retailer": "<string>",
  "products": [
    {
      "product_id": "<string>",
      "quantity": 123,
      "seller_selection_criteria": {
        "addon": true,
        "buy_box": true,
        "condition_in": [
          "<string>"
        ],
        "condition_not_in": [
          "<string>"
        ],
        "first_party_seller": true,
        "handling_days_max": 123,
        "international": true,
        "max_item_price": 123,
        "merchant_id_in": [
          "<string>"
        ],
        "merchant_id_not_in": [
          "<string>"
        ],
        "min_seller_num_ratings": 123,
        "min_seller_percent_positive_feedback": 123,
        "prime": true,
        "allow_oos": true
      }
    }
  ],
  "shipping_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "address_line1": "<string>",
    "address_line2": "<string>",
    "zip_code": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "phone_number": "<string>",
    "instructions": "<string>"
  },
  "shipping_method": "<string>",
  "shipping": {
    "order_by": "<string>",
    "max_days": 123,
    "max_price": 123
  },
  "billing_address": {
    "first_name": "<string>",
    "last_name": "<string>",
    "address_line1": "<string>",
    "address_line2": "<string>",
    "zip_code": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "phone_number": "<string>",
    "instructions": "<string>"
  },
  "payment_method": {
    "name_on_card": "<string>",
    "number": "<string>",
    "security_code": "<string>",
    "expiration_month": 123,
    "expiration_year": 123,
    "use_gift": true
  },
  "retailer_credentials": {
    "email": "<string>",
    "password": "<string>",
    "totp_2fa_key": "<string>"
  },
  "addax": true,
  "is_gift": true,
  "gift_message": "<string>",
  "require_gift": true,
  "webhooks": {
    "request_succeeded": "<string>",
    "request_failed": "<string>",
    "tracking_obtained": "<string>",
    "tracking_updated": "<string>",
    "status_updated": "<string>",
    "case_updated": "<string>"
  },
  "client_notes": {},
  "promo_codes": [
    {
      "code": "<string>",
      "optional": true,
      "merchant_id": "<string>",
      "discount_amount": 123,
      "discount_percentage": 123,
      "cost_override": 123
    }
  ],
  "strict_expired_product_id": true,
  "po_number": 123,
  "amazon_day": "<string>",
  "fail_if_taxed": true,
  "max_delivery_days": 123,
  "take_buybox_offers": true,
  "force_offers_postal_code": "<string>",
  "zma_discount": 123,
  "addax_queue_timeout": 123,
  "zma_prime_optout": true,
  "zma_priority_bid": 123,
  "max_price": 123
}'
{
  "request_id": "<string>"
}
Zinc offers two ways to place orders depending on your business needs. Choose the approach that works best for you:
Use your own Amazon, Walmart, or other retailer account credentials. You have full control over orders and can use your preferred payment methods.Required fields:
  • retailer - The retailer code of the supported retailer
  • products - A list of product objects that should be ordered
  • retailer_credentials - Your account login details
  • payment_method - Credit card or gift card balance
  • billing_address - Address associated with payment method
  • shipping_method or shipping - The desired shipping method
  • shipping_address - Where the order will be delivered
  • is_gift - Boolean indicating if this is a gift order

Order Flow

Making an order request will start an order. You’ll receive a request_id in the response which you’ll then use for retrieving the status of the order. The following illustration shows the flow for a typical order.
Order Status Flow

Order status flow for a typical Zinc order


Authorizations

Authorization
string
header
required

Use your client token as the username. Leave the password blank.

Body

application/json

Response

200 - application/json

Order created successfully

The response is of type object.