### GET /Shipments/Get/Details Source: https://share.apidog.com/apidoc/docs-site/620461/api-9095481 Retrieve an existing shipment using the shipment key (ShipmentID) or Reference. The response will contain the tracking number and required docs for the shipment. ```APIDOC ## GET /Shipments/Get/Details ### Description Retrieve an existing shipment using the shipment key (ShipmentID) or Reference. The response will contain the tracking number and required docs for the shipment. ### Method GET ### Endpoint /Shipments/Get/Details ### Parameters #### Query Parameters - **CustomerKey** (string) - Optional - CustomerKey - **Reference** (string) - Optional - Reference to get details - **ShipmentID** (string) - Optional - ShipmentID to get details - **isReturn** (boolean) - Optional - Set true to get the return shipment ### Request Example ```json { "CustomerKey": "YOUR_CUSTOMER_KEY", "Reference": "YOUR_REFERENCE", "ShipmentID": "YOUR_SHIPMENT_ID", "isReturn": false } ``` ### Response #### Success Response (200) - **ShipmentID** (string) - The unique id for the shipment that can be used to retrieve it later - **Status** (string) - Status - **Reference** (string) - The reference id that was sent in the request - **Message** (string) - Message - **TrackingNumber** (string) - Tracking number for the shipment - **TrackingUrl** (string) - The url to fetch the live tracking status of the shipment - **ConsolidateLabel** (string) - The url to fetch the generated consolidated label - **LabelUrl** (array of strings) - The url to fetch the generated label - **Carrier** (string) - Carrier - **CustomsInvoiceURL** (string) - The url to fetch the generated commercial invoice - **SubmittedElectronically** (boolean) - SubmittedElectronically #### Response Example ```json { "ShipmentID": "SHIPMENT_123", "Status": "Delivered", "Reference": "REF_XYZ", "Message": "Shipment delivered successfully.", "TrackingNumber": "TRACK_ABC", "TrackingUrl": "http://example.com/track/TRACK_ABC", "ConsolidateLabel": "http://example.com/label/consolidated/SHIPMENT_123", "LabelUrl": [ "http://example.com/label/SHIPMENT_123_1" ], "Carrier": "ExampleCarrier", "CustomsInvoiceURL": "http://example.com/invoice/SHIPMENT_123", "SubmittedElectronically": true } ``` #### Error Response (401, 422, 500) - **error** (object) - Contains error details. - **statusCode** (number) - The HTTP status code of the error. - **message** (string) - A descriptive message for the error. - **code** (string) - An error code. - **name** (string) - The name of the error. - **details** (array of objects) - An array of detailed error objects. - **requestId** (string) - The ID of the request for tracing purposes. #### Error Response Example ```json { "error": { "statusCode": 401, "message": "Authentication failed.", "code": "AUTH_ERROR", "name": "Unauthorized", "details": [], "requestId": "req_12345" } } ``` ``` -------------------------------- ### Fetch Invoices using OpenAPI Specification Source: https://share.apidog.com/apidoc/docs-site/620461/api-9441006 This snippet represents the OpenAPI 3.0.1 specification for the 'Get Invoices' API. It defines the endpoint, parameters (FromDate, ToDate, CustomerKey, InvoiceType), authentication method (bearer token), and the structure of the successful response, including invoice details. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /Invoices: get: summary: Get Invoices deprecated: false description: >- Fetch a list of invoice numbers within a specified date range. You can use results from this call to search for specific Invoice details in /Invoice/{InvoiceNumber} API. Must use bearer token method for authentication. tags: - Invoices parameters: - name: FromDate in: query description: >- Specifies the start date of the date range from which to retrieve invoice numbers. Format: YYYY-MM-DD required: true schema: type: string - name: ToDate in: query description: >- Specifies the end date of the date range from which to retrieve invoice numbers. Format: YYYY-MM-DD required: true schema: type: string - name: CustomerKey in: query description: Your unique FlavorCloud customer key. required: false schema: type: string - name: InvoiceType in: query description: >- Defines the type of invoices to retrieve. Possible values include: Standard, Reconciliation, Subscription and Manual. required: true schema: type: string enum: - Standard - Reconciliation - Subscription - Manual x-apidog-enum: - name: '' value: Standard description: '' - name: '' value: Reconciliation description: '' - name: '' value: Subscription description: '' - name: '' value: Manual description: '' responses: '200': description: '' content: application/json: schema: type: array items: type: object properties: InvoiceURL: type: string InvoiceURLXLS: type: string InvoiceNumber: type: string InvoiceAmount: type: number InvoiceStatus: type: string InvoiceType: type: string InvoiceDate: type: string x-apidog-orders: - InvoiceURL - InvoiceURLXLS - InvoiceNumber - InvoiceAmount - InvoiceStatus - InvoiceType - InvoiceDate required: - InvoiceURL - InvoiceURLXLS - InvoiceNumber - InvoiceAmount - InvoiceStatus - InvoiceType - InvoiceDate example: - InvoiceURL: >- https://cdn.flavorcloud.com/i-FLCL-1i89h2m6ei0o-payment-invoice.pdf InvoiceURLXLS: >- https://cdn.flavorcloud.com/FLCL-1i89h2m6ei0o-payment-invoice-1726896757265.xlsx InvoiceNumber: FLCL-1i89h2m6ei0o InvoiceAmount: 142.12 InvoiceStatus: PAID InvoiceType: Standard InvoiceDate: '2024-09-21T05:32:37.000Z' headers: {} x-apidog-name: Success security: - bearer: [] x-apidog-folder: Invoices x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/620461/apis/api-9441006-run components: schemas: {} securitySchemes: bearer: type: http scheme: bearer servers: - url: https://partnerapi.flavorcloud.com description: Prod Env security: [] ``` -------------------------------- ### POST /customers Source: https://share.apidog.com/apidoc/docs-site/620461/schema-2842841 Creates a new customer record with detailed shipping and account information. ```APIDOC ## POST /customers ### Description Creates a new customer record with detailed shipping and account information. ### Method POST ### Endpoint /customers ### Parameters #### Request Body - **LabelFormat** (string) - Optional - LabelFormat Default is PDF. Enum: PDF, ZPL - **WeightUnit** (string) - Optional - Unit for weight of the shipment. Default in KG. Enum: KG, LB - **DimensionUnit** (string) - Optional - Unit for dimensions of the shipment. Default is CM. Enum: IN, CM - **Insurance** (string) - Optional - Specify if insurance is required. Default is N. Enum: Y, N - **ServiceCode** (array[string]) - Optional - Service code. Default is ['STANDARD', 'EXPRESS', 'STANDARD-ECONOMY', 'EXPRESS-ECONOMY']. Enum: STANDARD, EXPRESS, STANDARD-ECONOMY, EXPRESS-ECONOMY - **TermsOfTrade** (array[string]) - Optional - Terms of trade can be Delivery Duty Paid (DDP) or Delivery Duty Unpaid (DDU). Default is ['DDU', 'DDP']. Enum: DDP, DDU - **AccountInformation** (object) - Required - Account details. - **Name** (string) - Description: Name of person. Both name and company can be included. - **AttentionName** (string) - Description: Attention name. - **ShippingOrigin** (object) - Required - Origin shipping details. - **LocationName** (string) - Required - Name of Location. - **AddressLine1** (string) - Required - First line of the address. - **AddressLine2** (string) - Optional - Second line of the address. - **AddressLine3** (string) - Optional - Third line of the address. - **City** (string) - Required - Full city name. - **State** (string) - Optional - State or province. - **Country** (string) - Required - ISO 3166 country code for the country the address is located in. - **Zip** (string) - Required - ZIP or postal code. - **Phone** (string) - Required - Phone number to reach the person or organization. - **Email** (string) - Required - Email to reach the person or organization. - **AveragePackageSettings** (object) - Required - Average package dimensions and weight. - **Weight** (number) - Description: Total average (scaled) weight of the package. - **Length** (number) - Description: Average Length of the parcel. - **Width** (number) - Description: Average of the parcel. - **Height** (number) - Description: Average of the parcel. - **OriginCountryCode** (string) - Description: Height of the parcel. - **PaymentKey** (string) - Required - PaymentKey ### Request Example ```json { "LabelFormat": "PDF", "WeightUnit": "KG", "DimensionUnit": "CM", "Insurance": "N", "ServiceCode": [ "STANDARD", "EXPRESS" ], "TermsOfTrade": [ "DDU" ], "AccountInformation": { "Name": "John Doe", "AttentionName": "Attn: John Doe" }, "ShippingOrigin": { "LocationName": "Warehouse A", "AddressLine1": "123 Main St", "City": "Anytown", "Country": "US", "Zip": "12345", "Phone": "555-123-4567", "Email": "origin@example.com" }, "AveragePackageSettings": { "Weight": 10.5, "Length": 20, "Width": 15, "Height": 10, "OriginCountryCode": "US" }, "PaymentKey": "PAYMENT_KEY_123" } ``` ### Response #### Success Response (200) - **LabelFormat** (string) - LabelFormat Default is PDF. Enum: PDF, ZPL - **WeightUnit** (string) - Unit for weight of the shipment. Default in KG. Enum: KG, LB - **DimensionUnit** (string) - Unit for dimensions of the shipment. Default is CM. Enum: IN, CM - **Insurance** (string) - Specify if insurance is required. Default is N. Enum: Y, N - **ServiceCode** (array[string]) - Service code. Default is ['STANDARD', 'EXPRESS', 'STANDARD-ECONOMY', 'EXPRESS-ECONOMY']. Enum: STANDARD, EXPRESS, STANDARD-ECONOMY, EXPRESS-ECONOMY - **TermsOfTrade** (array[string]) - Terms of trade can be Delivery Duty Paid (DDP) or Delivery Duty Unpaid (DDU). Default is ['DDU', 'DDP']. Enum: DDP, DDU - **AccountInformation** (object) - Account details. - **Name** (string) - Name of person. Both name and company can be included. - **AttentionName** (string) - Attention name. - **ShippingOrigin** (object) - Origin shipping details. - **LocationName** (string) - Name of Location. - **AddressLine1** (string) - First line of the address. - **AddressLine2** (string) - Second line of the address. - **AddressLine3** (string) - Third line of the address. - **City** (string) - Full city name. - **State** (string) - State or province. - **Country** (string) - ISO 3166 country code for the country the address is located in. - **Zip** (string) - ZIP or postal code. - **Phone** (string) - Phone number to reach the person or organization. - **Email** (string) - Email to reach the person or organization. - **AveragePackageSettings** (object) - Average package dimensions and weight. - **Weight** (number) - Total average (scaled) weight of the package. - **Length** (number) - Average Length of the parcel. - **Width** (number) - Average of the parcel. - **Height** (number) - Average of the parcel. - **OriginCountryCode** (string) - Height of the parcel. - **PaymentKey** (string) - PaymentKey #### Response Example ```json { "LabelFormat": "PDF", "WeightUnit": "KG", "DimensionUnit": "CM", "Insurance": "N", "ServiceCode": [ "STANDARD", "EXPRESS" ], "TermsOfTrade": [ "DDU" ], "AccountInformation": { "Name": "John Doe", "AttentionName": "Attn: John Doe" }, "ShippingOrigin": { "LocationName": "Warehouse A", "AddressLine1": "123 Main St", "City": "Anytown", "Country": "US", "Zip": "12345", "Phone": "555-123-4567", "Email": "origin@example.com" }, "AveragePackageSettings": { "Weight": 10.5, "Length": 20, "Width": 15, "Height": 10, "OriginCountryCode": "US" }, "PaymentKey": "PAYMENT_KEY_123" } ``` ``` -------------------------------- ### OpenAPI Specification for Get Auth Token Source: https://share.apidog.com/apidoc/docs-site/620461/api-16353083 This OpenAPI 3.0.1 specification defines the 'Get Auth Token' POST endpoint. It requires 'AppID' and 'RestApiKey' in the request body and returns a JWT 'Token', 'ExpiresIn' duration, and a 'RootRequestId' for tracking. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /Auth: post: summary: Get Auth Token deprecated: false description: '' tags: - Authentication parameters: [] requestBody: content: application/json: schema: type: object properties: AppID: type: string RestApiKey: type: string x-apidog-orders: - AppID - RestApiKey required: - AppID - RestApiKey example: AppID: app_id RestApiKey: rest_api_key responses: '200': description: '' content: application/json: schema: type: object properties: Token: type: string description: The JWT Bearer token for authenticating API calls RootRequestId: type: string description: >- Unique identifier of the API request for troubleshooting purposes ExpiresIn: type: string description: Number of seconds the JWT Bearer token is valid for x-apidog-orders: - Token - ExpiresIn - RootRequestId required: - Token - RootRequestId - ExpiresIn example: Token: >- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImwxY282ZzY4aHUiLCJlbmNyeXB0ZWRVc2VyUHJvZmlsZSI6IlUyRnNkR1ZrWDErK1dVWk93SGxGbFJlcXVnT3ZTZU5Mdmh5a1FTdjBubFFjTkN4dlJGbmZMV2djWUpYOTlTL294U1U2WEsvQXdMWVZtWFo3WkVOVWppQnFsV0I0TXZHMVptZjVxNXVnY2VBckVIR0pKMkhhL3VkU283OWRkb204UzRwbklVeTVRQmRRN2dyVXYvSnNjeDNXRXBCRXcwMklVRXM5bGVBZnVCeWFCdWx0TUl4MVVXWG5DRFN3UkhNYytYaGtTSDBrU3UveFhWcEVWcDJsckZ3N0UvenlGSUVOYjVSaExUMXFyOFVsWThDQ1BXTFkzanh5UE5FcE1JYk90bHQ1SVBTS2xWMVFVem9BcHpKOXMrcFlkTExybktYdUVINGFuYkZabHZ4WUl5Zy91dWFMOVh1Q2M0SlRrOUVNIiwiaWF0IjoxNzQ1ODU1NjI5LCJleHAiOjE3NDU4OTg4Mjl9.DwbG2dJyK4m9E8YMgdOlriP39WsUe3zXnfrjajXR4vg ExpiresIn: 43200 RootRequestId: a1a4b8a3-efef-43a6-8c34-9994f07bb800 headers: {} x-apidog-name: Success security: [] x-apidog-folder: Authentication x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/620461/apis/api-16353083-run components: schemas: {} securitySchemes: {} servers: - url: https://partnerapi.flavorcloud.com description: Prod Env security: [] ``` -------------------------------- ### Product Information Source: https://share.apidog.com/apidoc/docs-site/620461/api-9095483 Retrieves a list of different possible recommendations for products. This endpoint provides an overview of product classification and quality results based on provided information. ```APIDOC ## GET /products ### Description Retrieves a list of different possible recommendations for products. This endpoint provides an overview of product classification and quality results based on provided information. ### Method GET ### Endpoint /products ### Parameters #### Query Parameters - **Classification** (string) - Optional - Specifies the classification criteria for products. - **Quality** (string) - Optional - Filters products based on their quality rating. - **Description** (string) - Optional - Searches for products based on keywords in their description. - **Image** (string) - Optional - Filters products by image attributes. - **Title** (string) - Optional - Searches for products by their title. ### Request Example ```json { "example": "GET /products?Classification=Electronics&Quality=High" } ``` ### Response #### Success Response (200) - **products** (array) - A list of product objects, each containing details like title, description, image, classification, and quality. #### Response Example ```json { "example": [ { "Title": "Example Product 1", "Description": "This is a high-quality electronic gadget.", "Image": "http://example.com/image1.jpg", "Classification": "Electronics", "Quality": "High" }, { "Title": "Example Product 2", "Description": "A durable home appliance.", "Image": "http://example.com/image2.jpg", "Classification": "Home Appliances", "Quality": "Medium" } ] } ``` ``` -------------------------------- ### Get Shipping Rates Source: https://share.apidog.com/apidoc/docs-site/620461/schema-2842863 This endpoint allows you to get shipping rates by providing shipment details such as origin, destination, package dimensions, and weight. It supports various service levels and options like insurance and landed cost. ```APIDOC ## POST /rates ### Description Retrieves shipping rates based on provided shipment details. ### Method POST ### Endpoint /rates ### Parameters #### Request Body - **AppID** (string) - Required - Your FlavorCloud application id - **RestApiKey** (string) - Required - Your rest api key - **CustomerKey** (string) - Required - Customer key - **Reference** (string) - Required - Your order number or reference - **LabelFormat** (string) - Optional - Format for the label (default: PDF) - **WeightUnit** (string) - Required - Unit for weight (e.g., KG, LB) (default: KG) - **Currency** (string) - Required - Currency for the rate (e.g., USD) (default: USD) - **DimensionUnit** (string) - Required - Unit for dimensions (e.g., IN, CM) (default: IN) - **Insurance** (string) - Required - Specify if insurance is required (Y/N) (default: N) - **ServiceCode** (array[string]) - Optional - List of desired service codes (e.g., STANDARD, EXPRESS) (default: ["STANDARD", "EXPRESS", "STANDARD-ECONOMY", "EXPRESS-ECONOMY"]) - **TermsOfTrade** (array[string]) - Optional - Terms of trade (e.g., DDP, DDU) (default: ["DDP", "DDU"]) - **IsReturn** (string) - Optional - Set to "Y" to create a return label (default: 'N') - **IncludeLandedCost** (boolean) - Optional - Include Landed cost for DDP rates (default: true) - **ShipFromAddress** (object) - Required - Address details for the shipment origin - **Name** (string) - Required - Name of the contact person - **Street1** (string) - Required - Street address line 1 - **Street2** (string) - Optional - Street address line 2 - **City** (string) - Required - City - **State** (string) - Required - State or province code - **Zip** (string) - Required - Postal code - **Country** (string) - Required - Country code (ISO 3166-1 alpha-2) - **Phone** (string) - Required - Phone number - **Email** (string) - Required - Email address - **ShipToAddress** (object) - Required - Address details for the shipment destination (same schema as ShipFromAddress) - **ReasonForExport** (string) - Required - Reason for export (e.g., 'documents', 'gift', 'merchandise') (default: merchandise) - **Shipments** (array[object]) - Required - Array of shipment details - **Piece** (array[object]) - Required - Array of item details within the package - **Weight** (number) - Required - Weight of the item - **Length** (number) - Required - Length of the item - **Width** (number) - Required - Width of the item - **Height** (number) - Required - Height of the item - **Description** (string) - Required - Description of the item - **Quantity** (number) - Required - Quantity of the item - **Value** (number) - Required - Value of the item - **Currency** (string) - Required - Currency of the item's value - **OriginCountry** (string) - Required - Country of origin for the item - **HarmonizedCode** (string) - Optional - Harmonized System code for the item - **SKU** (string) - Optional - Stock Keeping Unit - **Package** (object) - Required - Package details - **Weight** (number) - Required - Total actual (scaled) weight of the package - **Length** (number) - Required - Length of the parcel when empty - **Width** (number) - Required - Width of the parcel when empty - **Height** (number) - Required - Height of the parcel when empty - **Reference** (string) - Optional - Reference for the package - **ITNNumber** (string) - Optional - ITN Number for customs declaration ### Request Example ```json { "AppID": "YOUR_APP_ID", "RestApiKey": "YOUR_REST_API_KEY", "CustomerKey": "YOUR_CUSTOMER_KEY", "Reference": "ORDER12345", "WeightUnit": "KG", "Currency": "USD", "DimensionUnit": "IN", "Insurance": "N", "ShipFromAddress": { "Name": "Sender Name", "Street1": "123 Sender St", "City": "Sender City", "State": "CA", "Zip": "90210", "Country": "US", "Phone": "555-123-4567", "Email": "sender@example.com" }, "ShipToAddress": { "Name": "Recipient Name", "Street1": "456 Recipient Ave", "City": "Recipient City", "State": "NY", "Zip": "10001", "Country": "US", "Phone": "555-987-6543", "Email": "recipient@example.com" }, "ReasonForExport": "merchandise", "Shipments": [ { "Piece": [ { "Weight": 1.5, "Length": 10, "Width": 8, "Height": 5, "Description": "T-shirt", "Quantity": 2, "Value": 25.00, "Currency": "USD", "OriginCountry": "CN" } ], "Package": { "Weight": 3.0, "Length": 12, "Width": 10, "Height": 6 } } ] } ``` ### Response #### Success Response (200) - **Rates** (array[object]) - List of available shipping rates - **ServiceLevel** (string) - Name of the service level - **ServiceCode** (string) - Code for the service level - **EstimatedDelivery** (string) - Estimated delivery time - **Cost** (number) - Cost of the shipment - **Currency** (string) - Currency of the cost - **TransitDays** (number) - Number of transit days - **Provider** (string) - Shipping provider name - **ProviderCode** (string) - Code for the shipping provider - **GuaranteedDelivery** (boolean) - Indicates if delivery is guaranteed - **LandedCost** (object) - Details about landed cost if applicable - **TotalCost** (number) - Total landed cost - **Currency** (string) - Currency of the landed cost - **Taxes** (number) - Total taxes - **Duties** (number) - Total duties #### Response Example ```json { "Rates": [ { "ServiceLevel": "Standard International", "ServiceCode": "STANDARD", "EstimatedDelivery": "5-7 business days", "Cost": 45.50, "Currency": "USD", "TransitDays": 5, "Provider": "Global Shipping Inc.", "ProviderCode": "GSI", "GuaranteedDelivery": false, "LandedCost": { "TotalCost": 55.00, "Currency": "USD", "Taxes": 5.00, "Duties": 4.50 } } ] } ``` ``` -------------------------------- ### GET /Invoices Source: https://share.apidog.com/apidoc/docs-site/620461/api-9441006 Fetches a list of invoice numbers within a specified date range. This can be used to find specific invoice details via the /Invoice/{InvoiceNumber} API. Authentication requires a bearer token. ```APIDOC ## GET /Invoices ### Description Fetch a list of invoice numbers within a specified date range. You can use results from this call to search for specific Invoice details in /Invoice/{InvoiceNumber} API. Must use bearer token method for authentication. ### Method GET ### Endpoint /Invoices ### Parameters #### Query Parameters - **FromDate** (string) - Required - Specifies the start date of the date range from which to retrieve invoice numbers. Format: YYYY-MM-DD - **ToDate** (string) - Required - Specifies the end date of the date range from which to retrieve invoice numbers. Format: YYYY-MM-DD - **CustomerKey** (string) - Optional - Your unique FlavorCloud customer key. - **InvoiceType** (string) - Required - Defines the type of invoices to retrieve. Possible values include: Standard, Reconciliation, Subscription and Manual. ### Request Example ```json { "FromDate": "2024-01-01", "ToDate": "2024-12-31", "InvoiceType": "Standard" } ``` ### Response #### Success Response (200) - **InvoiceURL** (string) - URL to the invoice PDF. - **InvoiceURLXLS** (string) - URL to the invoice in XLSX format. - **InvoiceNumber** (string) - The unique invoice number. - **InvoiceAmount** (number) - The total amount of the invoice. - **InvoiceStatus** (string) - The current status of the invoice (e.g., PAID). - **InvoiceType** (string) - The type of the invoice (e.g., Standard, Reconciliation). - **InvoiceDate** (string) - The date the invoice was issued. #### Response Example ```json [ { "InvoiceURL": "https://cdn.flavorcloud.com/i-FLCL-1i89h2m6ei0o-payment-invoice.pdf", "InvoiceURLXLS": "https://cdn.flavorcloud.com/FLCL-1i89h2m6ei0o-payment-invoice-1726896757265.xlsx", "InvoiceNumber": "FLCL-1i89h2m6ei0o", "InvoiceAmount": 142.12, "InvoiceStatus": "PAID", "InvoiceType": "Standard", "InvoiceDate": "2024-09-21T05:32:37.000Z" } ] ``` ``` -------------------------------- ### Package Schema Source: https://share.apidog.com/apidoc/docs-site/620461/schema-2842864 Defines the structure for package dimensions and weight. ```APIDOC ## Package Schema ### Description Represents the physical dimensions and weight of a package. ### Method N/A (Schema Definition) ### Endpoint N/A (Schema Definition) ### Parameters #### Request Body - **Weight** (number) - Required - Total actual (scaled) weight of the package. - **Length** (number) - Optional - Length of the parcel when empty. - **Width** (number) - Optional - Width of the parcel when empty. - **Height** (number) - Optional - Height of the parcel when empty. ### Request Example ```json { "Weight": 2.5, "Length": 20, "Width": 15, "Height": 10 } ``` ### Response #### Success Response (200) N/A (Schema Definition) #### Response Example N/A (Schema Definition) ``` -------------------------------- ### Get Tracking Detail API Endpoint - OpenAPI Source: https://share.apidog.com/apidoc/docs-site/620461/api-9095497 Defines the GET endpoint for retrieving shipment tracking details. It accepts a tracking number as a path parameter and optional headers for authentication and testing. The response includes tracking information or error details. ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /Tracking/Get/Detail/{TrackingNumber}: get: summary: Get Tracking Detail deprecated: false description: Get tracking status of the shipment operationId: Tracking.getTracking tags: - Tracking - Tracking parameters: - name: TrackingNumber in: path description: '' required: true example: '' schema: type: string - name: SetTestTrackingStatus in: query description: Set TestTracking Status - optional for testing required: false schema: type: string - name: Content-Type in: header description: '' required: false example: application/json schema: type: string - name: Authorization in: header description: '' required: false example: '{{JWT_TOKEN}}' schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/TrackingAPIResponse' headers: {} x-apidog-name: Get TrackingAPI Response '401': description: '' content: application/json: schema: &ref_0 $ref: '#/components/schemas/ErrorResponse' headers: {} x-apidog-name: Authentication Error '422': description: '' content: application/json: schema: *ref_0 headers: {} x-apidog-name: Validation Error '500': description: '' content: application/json: schema: *ref_0 headers: {} x-apidog-name: Error Response security: [] x-apidog-folder: Tracking x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/620461/apis/api-9095497-run components: schemas: TrackingAPIResponse: title: TrackingAPIResponse type: object properties: Reference: type: string description: The reference id that was sent in the request TrackingNumber: type: string description: Tracking number for the shipment TrackingHistory: type: array items: $ref: '#/components/schemas/TrackingHistory' EstimatedDelivery: type: string description: Estimated Delivery required: - Reference - TrackingNumber - TrackingHistory - EstimatedDelivery additionalProperties: false x-apidog-orders: - Reference - TrackingNumber - TrackingHistory - EstimatedDelivery x-apidog-ignore-properties: [] x-apidog-folder: '' TrackingHistory: title: TrackingHistory type: object properties: Location: type: string description: 'Address of the location the shipment is in ' StatusDate: type: string description: Date the status was updated StatusDetail: type: string description: More details on the status Status: type: string description: Status required: - Location - StatusDate - StatusDetail - Status additionalProperties: false x-apidog-orders: - Location - StatusDate - StatusDetail - Status x-apidog-ignore-properties: [] x-apidog-folder: '' ErrorResponse: title: ErrorResponse type: object properties: error: $ref: '#/components/schemas/ResponseData' required: - error additionalProperties: false x-apidog-orders: - error x-apidog-ignore-properties: [] x-apidog-folder: '' ResponseData: title: ResponseData type: object properties: statusCode: type: number description: number message: type: string description: Message code: type: string description: code name: type: string description: name details: type: array items: $ref: '#/components/schemas/ResponseDetails' requestId: type: string description: requestId required: - statusCode - message - code - name additionalProperties: false x-apidog-orders: - statusCode - message - code - name - details - requestId x-apidog-ignore-properties: [] x-apidog-folder: '' ResponseDetails: ``` -------------------------------- ### Create Customer API Source: https://share.apidog.com/apidoc/docs-site/620461/schema-2842840 This endpoint allows you to create a new customer profile within the FlavorCloud system. It requires detailed information about the customer, including account details, shipping origin, and package settings. ```APIDOC ## POST /customers ### Description Creates a new customer profile in the FlavorCloud system. ### Method POST ### Endpoint /customers ### Parameters #### Request Body - **AppID** (string) - Optional - Your FlavorCloud application id - **RestApiKey** (string) - Optional - Your rest api key - **PaymentKey** (string) - Required - PaymentKey - **LabelFormat** (string) - Optional - LabelFormat Default is PDF. Enum: PDF, ZPL - **WeightUnit** (string) - Optional - Unit for weight of the shipment. Default in KG. Enum: KG, LB - **DimensionUnit** (string) - Optional - Unit for dimensions of the shipment. Default is CM. Enum: IN, CM - **Insurance** (string) - Optional - Specify if insurance is required. Default is N. Enum: Y, N - **ServiceCode** (array of strings) - Optional - Service code. Default is ['STANDARD', 'EXPRESS', 'STANDARD-ECONOMY', 'EXPRESS-ECONOMY']. Enum: STANDARD, EXPRESS, STANDARD-ECONOMY, EXPRESS-ECONOMY - **TermsOfTrade** (array of strings) - Optional - Terms of trade can be Delivery Duty Paid (DDP) or Delivery Duty Unpaid (DDU). Default is ['DDU', 'DDP']. Enum: DDP, DDU - **AccountInformation** (object) - Required - Account details for the customer. - **ShippingOrigin** (object) - Required - Origin address details for shipments. - **AveragePackageSettings** (object) - Optional - Default package settings for the customer. ### Request Example ```json { "AppID": "your_app_id", "RestApiKey": "your_rest_api_key", "PaymentKey": "your_payment_key", "LabelFormat": "PDF", "WeightUnit": "KG", "DimensionUnit": "CM", "Insurance": "N", "ServiceCode": ["STANDARD", "EXPRESS"], "TermsOfTrade": ["DDU"], "AccountInformation": { "AccountNumber": "12345", "AccountPin": "67890" }, "ShippingOrigin": { "LocationName": "My Warehouse", "AddressLine1": "123 Main St", "City": "Anytown", "Country": "US", "Zip": "12345", "Phone": "555-123-4567", "Email": "warehouse@example.com" }, "AveragePackageSettings": { "Weight": 5, "Length": 30, "Width": 20, "Height": 10, "OriginCountryCode": "US" } } ``` ### Response #### Success Response (200) - **CustomerID** (string) - The unique identifier for the newly created customer. - **Message** (string) - A confirmation message indicating successful creation. #### Response Example ```json { "CustomerID": "cust_abc123", "Message": "Customer created successfully." } ``` ``` -------------------------------- ### WebHookInfo Object Details Source: https://share.apidog.com/apidoc/docs-site/620461/schema-2842884 This section details the structure and properties of the WebHookInfo object, used for configuring webhook subscriptions. ```APIDOC ## WebHookInfo Object ### Description Represents a webhook subscription configuration, specifying the events to subscribe to and the URL to receive notifications. ### Object Structure #### Properties - **EventName** (string) - Required - You can subscribe to one or more of the following events: - `SHIPMENT_CREATED` - `SHIPMENT_COMPLETED` - `SHIPMENT_CANCELLED` - `SHIPMENT_CANCELLATION_ERROR` - `SHIPMENT_ERROR` - `RETURN_SHIPMENT_CREATED` - `RETURN_SHIPMENT_ERROR` - `RETURN_SHIPMENT_CANCELLED` - `TRACKING_UPDATES` - `ORDER_PLACED` - `CONSOLIDATE_SHIPMENT_CREATED` - `CONSOLIDATE_SHIPMENT_ERROR` (Default: '') - **URL** (string) - Required - This is the URL that will be called when the subscribed event is triggered. ### Request Example ```json { "EventName": "SHIPMENT_CREATED", "URL": "https://example.com/webhook" } ``` ### Response Example (Success) ```json { "EventName": "SHIPMENT_CREATED", "URL": "https://example.com/webhook" } ``` ```