Orders

Orders

Experimental

Create order

post

Creates a new order with line items. Requires 'Idempotency-Key' header.

Required scopes

This endpoint requires the following scopes:

Authorizations

customer-api-authorizer & api-key

AuthorizationstringRequired

AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.

x-api-keystringRequired

API Gateway API key. Include as 'x-api-key: {key}' header.

Header parameters

Idempotency-Keystring · uuidRequired

Unique identifier for idempotency. If the same request is retried with the same key, the original response is returned.

Example: 550e8400-e29b-41d4-a716-446655440000

Body

application/jsontext/jsonapplication/*+json

Request payload for creating a new order.

requesterIdinteger · int64 · min: 1 · max: 99999999Required

Customer number placing the order.

userIdinteger · int64 · min: 1 · max: 99999999Required

User ID of the person creating the order.

facilityIdinteger · int64 · min: 1 · max: 99999999Required

Facility ID from customer profile.

shippingAddressIdinteger · int64 · min: 1 · max: 99999999Required

Shipping address ID from customer profile.

billingAddressIdinteger · int64 · min: 1 · max: 99999999Required

Billing address ID from customer profile.

shippingMethodstring · min: 1Required

Shipping method for the order.

useShippingAccountbooleanOptional

Indicates whether to use the customer's shipping account.

notesstring · max: 200 · nullableOptional

Special instructions or notes for the order.

Responses

200

Order created.

application/json

400

Validation errors.

application/json

403

CompanyId does not match authorized tenant.

application/json

502

External Orders API error.

application/json

post

/orders

HTTPcURLJavaScriptPython

POST /customer/orders HTTP/1.1
Host: api.partssource.com
Authorization: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000
Content-Type: application/json
Accept: */*
Content-Length: 540

{
  "requesterId": 2000001,
  "userId": 3000001,
  "facilityId": 1000001,
  "shippingAddressId": 4000001,
  "billingAddressId": 5000001,
  "shippingMethod": "STANDARD",
  "useShippingAccount": false,
  "quoteItems": [
    {
      "priceOptionId": "opt_320636703105",
      "productId": "O18256-DS100A1",
      "quantity": 2,
      "price": 59,
      "requiredFields": [
        {
          "fieldId": "22222222-2222-2222-2222-222222222222",
          "value": "WO-2025-0001"
        },
        {
          "fieldId": "44444444-4444-4444-4444-444444444444",
          "value": "EQ-SN-12345"
        }
      ]
    }
  ],
  "payment": {
    "paymentMethod": "PO",
    "poNumber": "PO-2025-001"
  },
  "notes": "Please ship to loading dock B"
}

application/jsontext/jsonapplication/*+json

{
  "data": {
    "orderNumber": "5499760",
    "createdAt": "2025-01-15T10:30:00.000Z",
    "eventId": "evt-550e8400-e29b-41d4-a716-446655440000"
  },
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

Experimental

Get order

get

Gets current status and details for an order.

Required scopes

This endpoint requires the following scopes:

Authorizations

customer-api-authorizer & api-key

AuthorizationstringRequired

AWS Cognito JWT token. Include as 'Authorization: Bearer {token}' header.

x-api-keystringRequired

API Gateway API key. Include as 'x-api-key: {key}' header.

Path parameters

orderIdinteger · int64Required

Responses

200

Order details.

application/json

404

Order not found.

application/json

get

/orders/{orderId}

HTTPcURLJavaScriptPython

GET /customer/orders/{orderId} HTTP/1.1
Host: api.partssource.com
Authorization: YOUR_API_KEY
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "orderId": 1234567,
    "status": "Researching",
    "orderDate": "2025-01-15T10:30:00.000Z",
    "lastUpdated": "2025-01-15T14:45:00.000Z",
    "total": 148.62,
    "items": [
      {
        "lineItemId": 8000001,
        "partNumber": "DS100A1",
        "description": "DS-100A SPO2 SENSOR ADULT WITH FINGERCLIP, 3 FT",
        "quantity": 2,
        "price": 118,
        "status": "Researching"
      }
    ],
    "shippingAddress": {
      "name": "Shipping Location",
      "line1": "123 Business Park Drive",
      "line2": "Building A",
      "city": "Springfield",
      "state": "IL",
      "zip": "62701",
      "country": "USA"
    }
  },
  "correlationId": "550e8400-e29b-41d4-a716-446655440000",
  "timestamp": "2025-01-15T10:30:00.000Z"
}